SpringBoot脚手架项目

简便SpringBoot项目开发，直接参考下面配置即可。

脚手架核心功能

JDK版本
build设置
返回值自动封装
单元测试
日志组件
swagger
MyBatis
HTTP交互编码
健康检查接口

Java编译

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
</properties>

以及：

<build>
    <finalName>${project.artifactId}</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

build设置

项目名称

配置 <finalName>${project.artifactId}</finalName>

Java版本

增加 maven-compiler-plugin 插件

源码打包

增加 maven-source-plugin 插件

deploy过滤

增加 maven-deploy-plugin 插件

spring boot 启动入口

增加 spring-boot-maven-plugin 插件

build汇总配置

<build>
    <finalName>${project.artifactId}</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>3.2.0</version>
            <executions>
                <execution>
                    <id>attach-sources</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>jar-no-fork</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <version>2.1.3.RELEASE</version>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-deploy-plugin</artifactId>
            <version>2.8.2</version>
            <configuration>
                <skip>true</skip>
            </configuration>
        </plugin>
    </plugins>
</build>

返回值自动封装

配置全局过滤

GlobalResponseHandler.java

import com.alibaba.fastjson.JSONObject;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@RestControllerAdvice
public class GlobalResponseHandler implements ResponseBodyAdvice<Object> {

    private static final JSONObject empty = new JSONObject();

    //判断支持的类型
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        // 检查注解是否存在，存在则忽略拦截
        if (methodParameter.getDeclaringClass().isAnnotationPresent(IgnoreResponseAdvice.class)) {
            return false;
        }
        if (methodParameter.getMethod().isAnnotationPresent(IgnoreResponseAdvice.class)) {
            return false;
        }
        // 忽略 springfox-swagger 相关请求，解决swagger请求异常的BUG
        if (methodParameter.getDeclaringClass().getName().contains("springfox")) {
            return false;
        }
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // 判断为null构建ResponseData对象进行返回
        if (o == null) {
            return Result.success(empty);
        }
        // 避免重复封装
        if (o instanceof Result) {
            return o;
        }
        return Result.success(o);
    }
}

手动去掉封装

IgnoreResponseAdvice.java

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

下划线和驼峰转换

参考：SpringBoot下划线和驼峰转换

单元测试

pom.xml

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

StudentTest.java

@ExtendWith(SpringExtension.class)
@SpringBootTest(classes = FunctionsDemoApplication.class)
public class StudentTest {

    @Autowired
    private StudentDao StudentDao;

    @Test
    public void select(){
        Student user = StudentDao.selectById(1);
        Assertions.assertEquals("aa", user.getName());
    }
}

logback

增加 janino 依赖：

<!--logback依赖包-->
<dependency>
    <groupId>org.codehaus.janino</groupId>
    <artifactId>janino</artifactId>
    <version>2.6.1</version>
</dependency>

配置文件参考： Java项目logback日志组件

swagger

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>

如果配置了全局过滤，比如返回值自动封装code和msg信息，可能会导致swagger请求异常，需要过滤 swagger相关请求，不需要进行结果的封装：

@RestControllerAdvice
public class GlobalResponseHandler implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        // 忽略 springfox-swagger 相关请求，解决swagger请求异常的BUG
        String className = methodParameter.getDeclaringClass().getName();
        if (className.contains(".springfox.") || className.contains(".springdoc.")) {
            return false;
        }
        return true;
    }
}

springdoc:
  swagger-ui:
    enabled: true

整合MyBatis

扫描注解

再spring整合mybatis的时候，有两个注解需要注意：

@SpringBootApplication(scanBasePackages ={}) scanBasePackages 中配置的扫描路径，只加载 @RestController、@Service、@Repository 等Spring中的注解，但是Mybatis的组件的注解，Spring扫描到了也不会加载解析。
@MapperScan 所有MyBatis的接口，都需要配置在这个扫描路径中，这样的话，所有Dao接口类，才会被加载生成操作数据库的代理类。但是要注意，如果使用了tk-myBatis需要使用tk的注解类。

<!--通用mapper-->
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
</dependency>
<!--分页插件-->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
</dependency>
<!--druid连接池-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
</dependency>
<!--mysql驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

HTTP交互编码

从Spring boot 2.2 开始，对于HTTP请求的默认编码不再是UTF-8，即便在 HttpMessageConverters 等序列化类中指定了UTF-8编码，但返回的HTTP返回头中的值依然是 Content-Type: application/json，而不是 Content-Type: application/json;charset=UTF-8，如果需要显示指定返回头中的编码是 UTF-8，需要在项目的 bootstrap.yml 配置文件中，添加如下配置：

spring:
  http:
    encoding:
      enabled: true
      force: true
      charset: UTF-8

健康检查接口

具体实现

HelloController.java

package com.demo.HelloController;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello(){
        return "Hello Kitty!";
    }
}

配置自动加载启动接口

resources/META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.demo.HelloController,\
……

参考资料

SpringBoot脚手架项目

文档信息

本文作者：Bob.Zhu
本文链接：https://adolphor.github.io/2022/10/12/01-spring-boot-template-project/
版权声明：自由转载-非商用-非衍生-保持署名（创意共享3.0许可证）

Bob的城堡