基于VertxWeb的SrpingMVC风格注解实现(一)

前言

最近了解到了vertx这个异步框架，但平时用的比较多的还是spring，出于好奇，尝试基于vertx web去实现spring mvc风格注解。

最终效果如下所示

@Slf4j
@RestController
public class HelloController {

    @RequestMapping("hello/world")
    public String helloWorld() {
        return "Hello world and nintha veladder";
    }

    @RequestMapping("echo")
    public Map echo(String message, Long token, int code, RoutingContext ctx) {
        log.info("uri={}", ctx.request().absoluteURI());

        log.info("message={}, token={}, code={}", message, token, code);
        HashMap map = new HashMap<>();
        map.put("message", message);
        map.put("token", token);
        map.put("code", code);
        return map;
    }

    @RequestMapping(value = "hello/array")
    public List> helloArray(long[] ids, String[] names, RoutingContext ctx) {
        log.info("ids={}", Arrays.toString(ids));
        log.info("names={}", Arrays.toString(names));
        return ctx.request().params().entries();
    }

    @RequestMapping("query/list")
    public List> queryArray(List ids, TreeSet names, LinkedList rawList, RoutingContext ctx) {
        log.info("ids={}", ids);
        log.info("names={}", names);
        log.info("rawList={}", rawList);
        return ctx.request().params().entries();
    }

    @RequestMapping("query/bean")
    public BeanReq queryBean(BeanReq req) {
        log.info("req={}", req);
        return req;
    }

    @RequestMapping(value = "post/body", method = HttpMethod.POST)
    public BeanReq postRequestBody(@RequestBody BeanReq req) {
        log.info("req={}", req);
        return req;
    }
}

完整实现见github repo: veladder

@RestContoller

现在主流spring mvc的控制器一般是使用@RestController注解，它的主要作用是告诉框架这个类是请求控制器，让框架主动扫描并加载这个类。

这个注解本质是个标记注解，所以目前不需要其他字段。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface RestController {
}

由于目前没有实现任何DI（依赖注入），为了方便我们直接在代码里面手动创建实例并加载。

@Override
public void start() throws Exception {
    HttpServer server = vertx.createHttpServer();

    Router router = Router.router(vertx);
    routerMapping(new HelloController(), router);

    server.requestHandler(router).listen(port, ar -> {
        if (ar.succeeded()) {
            log.info("HTTP Server is listening on {}", port);
        } else {
            log.error("Failed to run HTTP Server", ar.cause());
        }
    });
}

上面这段代码是在Verticle里面启动一个HTTP服务器，并进行路由构建。里面的routerMapping方法我们下面实现一下

private  void routerMapping(
    ControllerType annotatedBean, Router router) throws NotFoundException {
    
    Class clazz = (Class) annotatedBean.getClass();
    if (!clazz.isAnnotationPresent(RestController.class)) {
        return;
    }
    
    // other code
}

先简单判断下这个加载的类是否为带@RestController注解。好了，@RestContoller注解的任务已经完成了。

@RequestMapping

@RequestMapping注解的作用是把请求路径和我们的处理逻辑关联在一起。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface RequestMapping {
    String value() default "";

    HttpMethod[] method() default {};
}

value对应的path，而method对应http的请求方法，如GET、POST等。使用效果如下所示：

@RequestMapping(value = "post/body", method = HttpMethod.POST)

我们继续上一节的路由解析。

首先我们要获取到控制器类中被该注解标记的方法

Method[] methods = clazz.getDeclaredMethods();
for (Method method : methods) {
    if (!method.isAnnotationPresent(RequestMapping.class)) continue;
    
    // ... handle method code
}

这里使用了反射，并且只处理了带@RequestMapping注解的方法，然后从注解中获取请求路径和请求方法，具体代码如下所示

// ... handle method code
RequestMapping methodAnno = method.getAnnotation(RequestMapping.class);
String requestPath = methodAnno.value();

Handler requestHandler = ctx -> {
    // ... call annotated method and inject parameters
};

// bind handler to router
HttpMethod[] httpMethods = methodAnno.method();
if (httpMethods.length == 0) {
    // 默认绑定全部HttpMethod
    router.route(formatPath).handler(BodyHandler.create()).handler(requestHandler);
} else {
    for (HttpMethod httpMethod : httpMethods) {
        router
            .route(httpMethod, formatPath)
            .handler(BodyHandler.create())
            .handler(requestHandler);
    }
}

httpMethods这个参数我们采用了数组类型，这样一个处理函数可以绑定到多个HttpMethod中。这里还做了一个特殊处理，当用户省略这个参数时，将绑定全部HttpMethod，毕竟不绑定HttpMethod的处理函数没有意义。

上面代码中的requestHandler的功能是调用被注解的处理函数并注入所需要的参数，并将函数返回值转换为合适的格式再返回给请求者。个人感觉强大的参数注入功能可以极大的提升开发者的编码体验。接下来我们实现下requestHandler。

返回值处理

返回值一般有多种情况：

1. void类型，这种是无返回值，一般是特殊情况会使用。比如下载文件，无法以JSON形式返回，需要调用RoutingContext进行处理。
2. 基础类型和字符串，直接转换为JSON中的数字和字符串就好。
3. 其他类型，当POJO处理，直接序列化成JSON

处理返回值代码如下所示：

// Write to the response and end it
Consumer