cool.scx.core.ScxHttpRouter Maven / Gradle / Ivy

Go to download
package cool.scx.core;

import cool.scx.util.FileUtils;
import io.netty.handler.codec.http.HttpHeaderNames;
import io.netty.util.AsciiString;
import io.vertx.core.http.HttpMethod;
import io.vertx.ext.web.Route;
import io.vertx.ext.web.handler.BodyHandler;
import io.vertx.ext.web.handler.CorsHandler;
import io.vertx.ext.web.handler.impl.BodyHandlerImpl;
import io.vertx.ext.web.handler.impl.CorsHandlerImpl;
import io.vertx.ext.web.impl.RouterImpl;

import java.nio.file.Path;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * ScxHttp 路由 内部使用 vertxRouter 进行具体路由的处理
 *
 * @author scx567888
 * @version 1.11.8
 */
public final class ScxHttpRouter extends RouterImpl {

    /**
     * Constant defaultAllowedMethods
     */
    private static final Set DEFAULT_ALLOWED_METHODS = Set.of(
            HttpMethod.GET,
            HttpMethod.POST,
            HttpMethod.OPTIONS,
            HttpMethod.DELETE,
            HttpMethod.PATCH,
            HttpMethod.PUT
    );
    /**
     * Constant defaultAllowedHeaders
     */
    private static final Set DEFAULT_ALLOWED_HEADERS = toSet(
            HttpHeaderNames.ACCEPT,
            HttpHeaderNames.CONTENT_TYPE
    );
    /**
     * Constant defaultExposedHeaders
     */
    private static final Set DEFAULT_EXPOSED_HEADERS = toSet(
            HttpHeaderNames.CONTENT_DISPOSITION
    );

    /**
     * 默认 http 请求 body 限制大小
     */
    private static final long DEFAULT_BODY_LIMIT = FileUtils.displaySizeToLong("16384KB");

    //基本 handler
    private final CorsHandler corsHandler;
    private final BodyHandler bodyHandler;
    //基本 handler 对应的 路由
    private final Route corsHandlerRoute;
    private final Route bodyHandlerRoute;

    public ScxHttpRouter(Scx scx) {
        super(scx.vertx());
        //设置基本的 handler
        this.corsHandler = initCorsHandler(scx.scxOptions().allowedOrigin());
        this.bodyHandler = initBodyHandler(scx.scxEnvironment().getTempPath(BodyHandler.DEFAULT_UPLOADS_DIRECTORY));
        //注册路由
        this.corsHandlerRoute = this.route().handler(corsHandler);
        this.bodyHandlerRoute = this.route().handler(bodyHandler);
    }

    /**
     * toSet.
     *
     * @param values a {@link io.netty.util.AsciiString} object
     * @return a {@link java.util.Set} object
     */
    private static Set toSet(AsciiString... values) {
        return Stream.of(values).map(AsciiString::toString).collect(Collectors.toSet());
    }

    /**
     * initCorsHandler.
     *
     * @param allowedOriginPattern a {@link java.lang.String} object
     * @return a {@link io.vertx.ext.web.handler.CorsHandler} object
     */
    static CorsHandler initCorsHandler(String allowedOriginPattern) {
        return new CorsHandlerImpl().addOrigin(allowedOriginPattern)
                .allowedHeaders(DEFAULT_ALLOWED_HEADERS)
                .allowedMethods(DEFAULT_ALLOWED_METHODS)
                .exposedHeaders(DEFAULT_EXPOSED_HEADERS)
                .allowCredentials(true);
    }

    /**
     * initBodyHandler.
     *
     * @param uploadDirectory a {@link java.nio.file.Path} object
     * @return a {@link io.vertx.ext.web.handler.BodyHandler} object
     */
    static BodyHandler initBodyHandler(Path uploadDirectory) {
        return new BodyHandlerImpl(uploadDirectory.toString())
                .setBodyLimit(DEFAULT_BODY_LIMIT)
                .setMergeFormAttributes(false)
                .setDeleteUploadedFilesOnEnd(true);
    }

    /**
     * a
     *
     * @return a
     */
    public CorsHandler corsHandler() {
        return corsHandler;
    }

    /**
     * a
     *
     * @return a
     */
    public BodyHandler bodyHandler() {
        return bodyHandler;
    }

    /**
     * a
     *
     * @return a
     */
    public Route corsHandlerRoute() {
        return corsHandlerRoute;
    }

    /**
     * a
     *
     * @return a
     */
    public Route bodyHandlerRoute() {
        return bodyHandlerRoute;
    }

}