从零搭建Spring Boot脚手架（2）：增加通用的功能

1. 前言

今天开始搭建我们的kono Spring Boot脚手架，首先会集成Spring MVC并进行定制化以满足日常开发的需要，我们先做一些刚性的需求定制，后续再补充细节。如果你看了本文有什么问题可以留言讨论。多多持续关注，共同学习，共同进步。

Gitee： https://gitee.com/felord/kono
GitHub: https://github.com/NotFound40...

2. 统一返回体

在开发中统一返回数据非常重要。方便前端统一处理。通常设计为以下结构：

{
    "code": 200,
    "data": {
        "name": "felord.cn",
        "age": 18
    },
    "msg": "",
    "identifier": ""
}

code 业务状态码，设计时应该区别于http状态码。
data 数据载体，用以装载返回给前端展现的数据。
msg 提示信息，用于前端调用后返回的提示信息，例如 “新增成功”、“删除失败”。
identifier 预留的标识位，作为一些业务的处理标识。

根据上面的一些定义，声明了一个统一返回体对象RestBody<T>并声明了一些静态方法来方便定义。

package cn.felord.kono.advice;

import lombok.Data;

import java.io.Serializable;

/**
 * @author felord.cn
 * @since 22:32  2019-04-02
 */
@Data
public class RestBody<T> implements Rest<T>, Serializable {

    private static final long serialVersionUID = -7616216747521482608L;
    private int code = 200;
    private T data;
    private String msg = "";
    private String identifier = "";
 

    public static Rest<?> ok() {
        return new RestBody<>();
    }

    public static Rest<?> ok(String msg) {
        Rest<?> restBody = new RestBody<>();
        restBody.setMsg(msg);
        return restBody;
    }

    public static <T> Rest<T> okData(T data) {
        Rest<T> restBody = new RestBody<>();
        restBody.setData(data);
        return restBody;
    }

    public static <T> Rest<T> okData(T data, String msg) {
        Rest<T> restBody = new RestBody<>();
        restBody.setData(data);
        restBody.setMsg(msg);
        return restBody;
    }


    public static <T> Rest<T> build(int code, T data, String msg, String identifier) {
        Rest<T> restBody = new RestBody<>();
        restBody.setCode(code);
        restBody.setData(data);
        restBody.setMsg(msg);
        restBody.setIdentifier(identifier);
        return restBody;
    }

    public static Rest<?> failure(String msg, String identifier) {
        Rest<?> restBody = new RestBody<>();
        restBody.setMsg(msg);
        restBody.setIdentifier(identifier);
        return restBody;
    }

    public static Rest<?> failure(int httpStatus, String msg ) {
        Rest<?> restBody = new RestBody< >();
        restBody.setCode(httpStatus);
        restBody.setMsg(msg);
        restBody.setIdentifier("-9999");
        return restBody;
    }

    public static <T> Rest<T> failureData(T data, String msg, String identifier) {
        Rest<T> restBody = new RestBody<>();
        restBody.setIdentifier(identifier);
        restBody.setData(data);
        restBody.setMsg(msg);
        return restBody;
    }

    @Override
    public String toString() {
        return "{" +
                "code:" + code +
                ", data:" + data +
                ", msg:" + msg +
                ", identifier:" + identifier +
                '}';
    }
}

但是每次都要显式声明返回体也不是很优雅的办法，所以我们希望无感知的来实现这个功能。Spring Framework正好提供此功能，我们借助于@RestControllerAdvice和ResponseBodyAdvice<T>来对项目的每一个@RestController标记的控制类的响应体进行后置切面通知处理。

/**
 * 统一返回体包装器
 *
 * @author felord.cn
 * @since 14:58
 **/
@RestControllerAdvice
public class RestBodyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // 如果为空 返回一个不带数据的空返回体       
        if (o == null) {
            return RestBody.ok();
        }
        // 如果 RestBody 的 父类 是 返回值的父类型 直接返回 
        // 方便我们可以在接口方法中直接返回RestBody
        if (Rest.class.isAssignableFrom(o.getClass())) {
            return o;
        }
        // 进行统一的返回体封装
        return RestBody.okData(o);
    }
}

当我们接口返回一个实体类时会自动封装到统一返回体RestBody<T>中。

既然有ResponseBodyAdvice,就有一个RequestBodyAdvice，它似乎是来进行前置处理的，以后可能有一些用途。

2. 统一异常处理

统一异常也是@RestControllerAdvice能实现的，可参考之前的Hibernate Validator校验参数全攻略。这里初步集成了校验异常的处理，后续会添加其他异常。

/**
 * 统一异常处理
 *
 * @author felord.cn
 * @since 13 :31  2019-04-11
 */
@Slf4j
@RestControllerAdvice
public class ApiExceptionHandleAdvice {

    @ExceptionHandler(BindException.class)
    public Rest<?> handle(HttpServletRequest request, BindException e) {
        logger(request, e);
        List<ObjectError> allErrors = e.getAllErrors();
        ObjectError objectError = allErrors.get(0);
        return RestBody.failure(700, objectError.getDefaultMessage());
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Rest<?> handle(HttpServletRequest request, MethodArgumentNotValidException e) {
        logger(request, e);
        List<ObjectError> allErrors = e.getBindingResult().getAllErrors();
        ObjectError objectError = allErrors.get(0);
        return RestBody.failure(700, objectError.getDefaultMessage());
    }

    @ExceptionHandler(ConstraintViolationException.class)
    public Rest<?> handle(HttpServletRequest request, ConstraintViolationException e) {
        logger(request, e);
        Optional<ConstraintViolation<?>> first = e.getConstraintViolations().stream().findFirst();
        String message = first.isPresent() ? first.get().getMessage() : "";
        return RestBody.failure(700, message);
    }


    @ExceptionHandler(Exception.class)
    public Rest<?> handle(HttpServletRequest request, Exception e) {
        logger(request, e);
        return RestBody.failure(700, e.getMessage());
    }


    private void logger(HttpServletRequest request, Exception e) {
        String contentType = request.getHeader("Content-Type");
        log.error("统一异常处理 uri: {} content-type: {} exception: {}", request.getRequestURI(), contentType, e.toString());
    }
}

3. 简化类型转换

简化Java Bean之间转换也是一个必要的功能。这里选择mapStruct,类型安全而且容易使用，比那些BeanUtil要好用的多。但是从我使用的经验上来看，不要使用mapStruct提供的复杂功能只做简单映射。详细可参考文章Spring Boot 2 实战：集成 MapStruct 类型转换。

集成进来非常简单，由于它只在编译期生效所以引用时的scope最好设置为compile,我们在kono-dependencies中加入其依赖管理：

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>${mapstruct.version}</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>${mapstruct.version}</version>
    <scope>compile</scope>
</dependency>

在kono-app中直接引用上面两个依赖，但是这样还不行，和lombok一起使用编译容易出现SPI错误。我们还需要集成相关的Maven插件到kono-app编译的生命周期中去。参考如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.1</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <showWarnings>true</showWarnings>
        <annotationProcessorPaths>
            <path>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </path>
            <path>
                <groupId>org.mapstruct</groupId>
                <artifactId>mapstruct-processor</artifactId>
                <version>${mapstruct.version}</version>
            </path>
        </annotationProcessorPaths>
    </configuration>
</plugin>

然后我们就很容易将一个Java Bean转化为另一个Java Bean。下面这段代码将UserInfo转换为UserInfoVO而且自动为UserInfoVO.addTime赋值为当前时间，同时这个工具也自动注入了Spring IoC，而这一切都发生在编译期。

编译前：

/**
 * @author felord.cn
 * @since 16:09
 **/
@Mapper(componentModel = "spring", imports = {LocalDateTime.class})
public interface BeanMapping {

    @Mapping(target = "addTime", expression = "java(LocalDateTime.now())")
    UserInfoVO toUserInfoVo(UserInfo userInfo);

}

编译后：

package cn.felord.kono.beanmapping;

import cn.felord.kono.entity.UserInfo;
import cn.felord.kono.entity.UserInfoVO;
import java.time.LocalDateTime;
import javax.annotation.Generated;
import org.springframework.stereotype.Component;

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2020-07-30T23:11:24+0800",
    comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_252 (AdoptOpenJDK)"
)
@Component
public class BeanMappingImpl implements BeanMapping {

    @Override
    public UserInfoVO toUserInfoVo(UserInfo userInfo) {
        if ( userInfo == null ) {
            return null;
        }

        UserInfoVO userInfoVO = new UserInfoVO();

        userInfoVO.setName( userInfo.getName() );
        userInfoVO.setAge( userInfo.getAge() );

        userInfoVO.setAddTime( LocalDateTime.now() );

        return userInfoVO;
    }
}

其实mapStruct也就是帮我们写了Getter和Setter，但是不要使用其比较复杂的转换，会增加学习成本和可维护的难度。

4. 单元测试

将以上功能集成进去后分别做一个单元测试，全部通过。

    @Autowired
    MockMvc mockMvc;
    @Autowired
    BeanMapping beanMapping;

    /**
     * 测试全局异常处理.
     *
     * @throws Exception the exception
     * @see UserController#getUserInfo()
     */
    @Test
    void testGlobalExceptionHandler() throws Exception {

        String rtnJsonStr = "{\n" +
                "    \"code\": 700,\n" +
                "    \"data\": null,\n" +
                "    \"msg\": \"test global exception handler\",\n" +
                "    \"identifier\": \"-9999\"\n" +
                "}";

        mockMvc.perform(MockMvcRequestBuilders.get("/user/get"))
                .andExpect(MockMvcResultMatchers.content()
                        .json(rtnJsonStr))
                .andDo(MockMvcResultHandlers.print());
    }

    /**
     * 测试统一返回体.
     *
     * @throws Exception the exception
     * @see UserController#getUserVO()
     */
    @Test
    void testUnifiedReturnStruct() throws Exception {
//        "{\"code\":200,\"data\":{\"name\":\"felord.cn\",\"age\":18,\"addTime\":\"2020-07-30T13:08:53.201\"},\"msg\":\"\",\"identifier\":\"\"}";
        mockMvc.perform(MockMvcRequestBuilders.get("/user/vo"))
                .andExpect(MockMvcResultMatchers.jsonPath("code", Is.is(200)))
                .andExpect(MockMvcResultMatchers.jsonPath("data.name", Is.is("felord.cn")))
                .andExpect(MockMvcResultMatchers.jsonPath("data.age", Is.is(18)))
                .andExpect(MockMvcResultMatchers.jsonPath("data.addTime", Is.is(notNullValue())))
                .andDo(MockMvcResultHandlers.print());
    }


    /**
     * 测试 mapStruct类型转换.
     *
     * @see BeanMapping
     */
    @Test
    void testMapStruct() {
        UserInfo userInfo = new UserInfo();
        userInfo.setName("felord.cn");
        userInfo.setAge(18);
        UserInfoVO userInfoVO = beanMapping.toUserInfoVo(userInfo);

        Assertions.assertEquals(userInfoVO.getName(), userInfo.getName());
        Assertions.assertNotNull(userInfoVO.getAddTime());
    }

5. 总结

自制脚手架初步具有了统一返回体、统一异常处理、快速类型转换，其实参数校验也已经支持了。后续就该整合数据库了，常用的数据库访问技术主要为Mybatis、Spring Data JPA、JOOQ等，不知道你更喜欢哪一款？欢迎留言讨论。

关注公众号：Felordcn 获取更多资讯

个人博客：https://felord.cn

从零搭建Spring Boot脚手架（2）：增加通用的功能

1. 前言

2. 统一返回体

2. 统一异常处理

3. 简化类型转换

4. 单元测试

5. 总结

码农小胖哥

引用和评论

这个Spring Security登录插件牛啊，验证码、小程序、OAuth2都能快速接入

Bitmap 和布隆过滤器傻傻分不清？你这不应该啊

Jerry和您聊聊Chrome开发者工具

Spring 实现 3 种异步流式接口，干掉接口超时烦恼

💢线上高延迟请求排查

这些年

一文讲清楚static关键字

从零搭建Spring Boot脚手架（2）：增加通用的功能

1. 前言

2. 统一返回体

2. 统一异常处理

3. 简化类型转换

4. 单元测试

5. 总结

码农小胖哥

引用和评论

这个Spring Security登录插件牛啊，验证码、小程序、OAuth2都能快速接入

Bitmap 和 布隆过滤器傻傻分不清？你这不应该啊

Jerry和您聊聊Chrome开发者工具

Spring 实现 3 种异步流式接口，干掉接口超时烦恼

💢线上高延迟请求排查

这些年

一文讲清楚static关键字

Bitmap 和布隆过滤器傻傻分不清？你这不应该啊