Content-Type-Checker

Content-Type-Checkerとは

Content-Type-Checkerは、KtorのPluginであり、 Content-Typeを確認して、処理を加えることのできるライブラリです。

使い方

1. build.gradleやMavenに記述（例はbuild.gradle.kts）

repositories {
    maven { url = uri("https://wansuko-cmd.github.io/maven/") }
}

//Content-Type-Checker
implementation("com.wsr:content-type-checker:0.0.4")

2. installする

//デフォルト値を設定
install(ContentTypeChecker){

    //正しいContent-Typeの時の処理
    onSuccess = {
        println("Content-Type: ${call.request.contentType()}")
        call.respond("Success")
    }

    ////間違っているContent-Typeの時の処理
    onError = {
        println("Allowed: [${it.joinToString(", ")}], Request: ${call.request.contentType()}")
        call.respond(
            HttpStatusCode.UnsupportedMediaType,
            "Error"
        )
    }

    //Content-Typeが間違っているときに、処理を続けるかどうか
    continueOnError = false
}

3. Routeでラップする

//許可するContent-Typeを記述
allowContentType(
    ContentType.Application.Json, ContentType.Application.JavaScript
){
    get{
        //Something
    }

    post{
        //Something
    }
}

//デフォルト値をオーバーライドすることも可能
allowContentType(
    ContentType.Audio.Any,
    onSuccess = {
        call.respond(HttpStatusCode.NotFound)
    }
){
    get("world"){
        //Something
    }
    post("world") {
        //Something
    }
}

install時に設定できる値

全て省略可能です

onSuccess

型

suspend PipelineContext<Unit, ApplicationCall>.(List) -> Unit

内容

指定したContent-Typeのリクエストが来た時に走る処理を記述します。 この処理が走った後で、もともとのルート内の処理が走ります。

書き方の例

onSuccess = {
    println("Content-Type: ${call.request.contentType()}")
    
    call.respond("${it.joinToString(", ")}に含まれます")
}

thisはPipelineで、普通のRouteと同じように記述可能です。 また、itはListで、指定したContentTypeのリストを取得できます。

onSuccessWhenAllow

型

suspend PipelineContext<Unit, ApplicationCall>.(List) -> Unit

内容

onSuccessとほぼ同じですが、allowContentTypeの処理範囲内の場合こちらが適用されます。 設定していなければonSuccessが適用されます

onSuccessWhenNegative

型

suspend PipelineContext<Unit, ApplicationCall>.(List) -> Unit

内容

onSuccessとほぼ同じですが、negativeContentTypeの処理範囲内の場合こちらが適用されます。 設定していなければonSuccessが適用されます

onError

型

suspend PipelineContext<Unit, ApplicationCall>.(List) -> Unit

内容

指定したContent-Typeとは違うリクエストが来た時に走る処理を記述します。 この処理が走った後で、continueOnErrorの値によって、もともとの処理が走るかどうかが 決まります。

onErrorWhenAllow

型

suspend PipelineContext<Unit, ApplicationCall>.(List) -> Unit

内容

onErrorとほぼ同じですが、allowContentTypeの処理範囲内の場合こちらが適用されます。 設定していなければonErrorが適用されます

onErrorWhenNegative

型

suspend PipelineContext<Unit, ApplicationCall>.(List) -> Unit

内容

onErrorとほぼ同じですが、negativeContentTypeの処理範囲内の場合こちらが適用されます。 設定していなければonErrorが適用されます

continueOnError

型

Boolean

内容

指定したContent-Typeとは違うリクエストが来た時に、onErrorの処理を 実行した後、もともとの処理を走らせるかどうかを指定します。 初期値はtrueです。

書き方

//この時、処理は中断されます
continueOnError = false

Route内での書き方

実際にRouteで利用する際にはallowContentTypeもしくはnegativeContentTypeを使います。 これら二つの違いは、ContentTypeを指定する時に、 ホワイトリスト形式でContentTypeを指定するか、 ブラックリスト形式で指定するかです。

//許可するContent-Typeを記述
allowContentType(
    ContentType.Application.Json, ContentType.Application.JavaScript
){
    get("allow") {
        //Something
    }

    post("allow") {
        //Something
    }
}

//許可しないContent-Typeを記述
negativeContentType(
    ContentType.Application.Xml, ContentType.Application.GZip
) {
    get("negative") {
        //Something
    }

    post("negative") {
        //Something
    }
}

Content-Typeのホワイトリストorブラックリストを列挙する形で第一引数に渡します

また、ここでデフォルト値をオーバーライドすることが可能です。 オーバーライドをした場合、そちらの処理が優先されます。

サンプルアプリ

サンプルは、このプロジェクトのsampleに記述しています。

注意点

このライブラリはあくまでContent-Typeによって処理を挟みこみ、 中断させることを可能にするものです。 そのため、例えばacceptのように、allowContentTypeで囲っておけば 同じルートが使える、というわけではありません。

例えば下の例だと正常に動かない場合があります。

allowContentType(
    ContentType.Application.Json
){
    get("allow"){
        //Something
    }
}

allowContentType(
    ContentType.Audio.Any,
){
    get("allow"){
        //Something
    }
}

この場合は、acceptと組み合わせて利用するようにするか、 ルートを分けるようにしてください。

また、こちらのライブラリは出来立てほやほやで、破壊的な変更が加えられる場合があります。

バグなどありましたらissueの方に投げていただいたり、pull requestを作成していただけたら 幸いです。

よろしくお願いいたします。