【请查收!】一份 Spring Boot 项目搭建模板

痛定思痛。 2022-12-19 01:29 171阅读 0赞

微信关注公众号“java大数据修炼之道”,选择“设为星标”

# 优质文章和精品资源, 第一时间送达 #

![format_png][]

**关注订阅号「**Java大数据修炼之道**」，收看更多精彩内容**

> 作者：不一样的科技宅 
> 
> 来源：juejin.im/post/6844904083942277127

### 前言 ###

建立一个全新的项目，或者把旧的庞大的项目，进行拆分成多个项目。在建立新的项目中，经常需要做一些重复的工作，比如说拷贝一下常用的工具类，通用代码等等。所以就可以做一个基础的项目方便使用，在经历新项目的时候，直接在基础项目上进行简单配置就可以开发业务代码了。

### 基础项目该包含哪些东西。 ###

*  Swagger在线接口文档。
 *  CodeGenerator 代码生成器。
 *  统一返回。
 *  通用的分页对象。
 *  常用工具类。
 *  全局异常拦截。
 *  错误枚举。
 *  自定义异常。
 *  多环境配置文件。
 *  Maven多环境配置。
 *  日志配置。
 *  JenkinsFile。

--------------------

### Swagger ###

写接口文档通常是一件比较头疼的事情，然而swagger就用是用来帮我们解决这个问题的。可以在线生成接口文档，并且可以在页面上进行测试。

![format_png 1][]

可以非常清楚的显示，请求数据已经响应数据。当然这一切都需要在代码中进行配置。

![format_png 2][]

**注意的点：接口文档只能在测试/开发环境开启，其他环境请关闭。**

常用的Swagger注解

*  `@Api用于Controller`
 *  `@ApiOperation用于Controller内的方法。`
 *  `@ApiResponses用于标识接口返回数据的类型。`
 *  `@ApiModel用于标识类的名称`
 *  `@ApiModelProperty用于标识属性的名称`

案例

@RestController
    @Api(tags = "用户")
    @AllArgsConstructor
    @RequestMapping("/user")
    public class UserController {
    
        private IUserService userService;
    
        /**
         * 获取用户列表
         * @param listUserForm 表单数据
         * @return 用户列表
         */
        @ApiOperation("获取用户列表")
        @GetMapping("/listUser")
        @ApiResponses(
                @ApiResponse(code = 200, message = "操作成功", response = UserVo.class)
        )
        public ResultVo listUser(@Validated ListUserForm listUserForm){
            return ResultVoUtil.success(userService.listUser(listUserForm));
        }
    
    }

@Data
    @ApiModel("获取用户列表需要的表单数据")
    @EqualsAndHashCode(callSuper = false)
    public class ListUserForm extends PageForm<ListUserForm> {
    
        /**
         * 用户状态
         */
        @ApiModelProperty("用户状态")
        @NotEmpty(message = "用户状态不能为空")
        @Range(min =  -1 , max = 1 , message = "用户状态有误")
        private String status;
    
    }

对应的swagger的配置可以查看基础项目内的`SwaggerConfiguration.java`.

### CodeGenerator代码生成器。 ###

mybatis\_plus代码生成器可以帮我们生成`entity`,`service`,`serviceImpl`,`mapper`,`mapper.xml`。省去了建立一大堆实体类的麻烦。

由于配置太长这里就不贴出来了，对应的CodeGenerator的配置可以查看基础项目内的`CodeGenerator.java`.

--------------------

### 常用的封装 ###

统一返回 ResultVo

将所有的接口的响应数据的格式进行统一。

@Data
    @ApiModel("固定返回格式")
    public class ResultVo {
    
        /**
         * 错误码
         */
        @ApiModelProperty("错误码")
        private Integer code;
    
        /**
         * 提示信息
         */
        @ApiModelProperty("提示信息")
        private String message;
    
        /**
         * 具体的内容
         */
        @ApiModelProperty("响应数据")
        private Object data;
    
    }

抽象表单 BaseForm

public abstract class BaseForm<T> {
    
        /**
         * 获取实例
         * @return 返回实体类
         */
        public abstract T buildEntity();
    
    }

有小伙伴可能有疑问了，这个类有啥用呢。先看一下，下面的代码。

/**
         * 添加用户
         * @param userForm 表单数据
         * @return true 或者 false
         */
        @Override
        public boolean addUser(AddUserForm userForm) {
            User user = new User();
            user.setNickname(userForm.getNickname());
            user.setBirthday(userForm.getBirthday());
            user.setUsername(userForm.getUsername());
            user.setPassword(userForm.getPassword());
            return save(user);
        }

重构一下，感觉清爽了一些。

/**
     * 添加用户
     * @param userForm 表单数据
     * @return true 或者 false
     */
    @Override
    public boolean addUser(AddUserForm userForm) {
        User user = new User();
        BeanUtils.copyProperties(this,user);
        return save(user);
    }

使用BaseForm进行重构 AddUserForm 继承 BaseForm并重写buildEntity

@Data
    @EqualsAndHashCode(callSuper = false)
    public class AddUserForm extends BaseForm<User> {
    
        /**
         * 昵称
         */
        private String nickname;
    
        /**
         * 生日
         */
        private Date birthday;
    
        /**
         * 用户名
         */
        private String username;
    
        /**
         * 密码
         */
        private String password;
    
        /**
         * 构造实体
         * @return 实体对象
         */
        @Override
        public User buildEntity() {
            User user = new User();
            BeanUtils.copyProperties(this,user);
            return user;
        }
    }
    复制代码

/**
     * 添加用户
     * @param userForm 表单数据
     * @return true 或者 false
     */
    @Override
    public boolean addUser(AddUserForm userForm) {
        return save(userForm.buildEntity());
    }

上面的代码有没有种似曾相识的感觉，很多情况都是将接受到的参数，转变成对应的实体类然后**保存**或者**更新**。所以对于这类的`form`可以继承`baseform`并实现`buildEntity()`这样可以更加符合面向对象，`service`不需要关心`form`如何转变成`entity`,只需要在使用的时候调用`buildEntity()`即可，尤其是在`form` \-> `entity`相对复杂的时候，这样做可以减少`service`内的代码。让代码逻辑看起来更加清晰。

--------------------

### 通用的分页对象 ###

涉及到查询的时候，绝大多数都需要用到分页，所以说封装分页对象就很有必要。可以注意下 `PageForm.calcCurrent()`、`PageVo.setCurrentAndSize()`、`PageVo.setTotal()`这个几个方法。

PageForm

@Data
    @ApiModel(value = "分页数据", description = "分页需要的表单数据")
    public class PageForm<T extends PageForm<?>>{
    
        /**
         * 页码
         */
        @ApiModelProperty(value = "页码 从第一页开始 1")
        @Min(value = 1, message = "页码输入有误")
        private Integer current;
    
        /**
         * 每页显示的数量
         */
        @ApiModelProperty(value = "每页显示的数量 范围在1~100")
        @Range(min = 1, max = 100, message = "每页显示的数量输入有误")
        private Integer size;
    
        /**
         * 计算当前页 ,方便mysql 进行分页查询
         * @return 返回 pageForm
         */
        @ApiModelProperty(hidden = true)
        public T calcCurrent(){
            current = (current - 1 ) * size;
            return (T) this;
        }
    }

PageVo

@Data
    public class PageVo<T> {
        /**
         * 分页数据
         */
        @ApiModelProperty(value = "分页数据")
        private List<T> records;
        /**
         * 总条数
         */
        @ApiModelProperty(value = "总条数")
        private Integer total;
    
        /**
         * 总页数
         */
        @ApiModelProperty(value = "总页数")
        private Integer pages;
    
        /**
         * 当前页
         */
        @ApiModelProperty(value = "当前页")
        private Integer current;
    
        /**
         * 查询数量
         */
        @ApiModelProperty(value = "查询数量")
        private Integer size;
    
        /**
         * 设置当前页和每页显示的数量
         * @param pageForm 分页表单
         * @return 返回分页信息
         */
        @ApiModelProperty(hidden = true)
        public PageVo<T> setCurrentAndSize(PageForm<?> pageForm){
            BeanUtils.copyProperties(pageForm,this);
            return this;
        }
    
        /**
         * 设置总记录数
         * @param total 总记录数
         */
        @ApiModelProperty(hidden = true)
        public void setTotal(Integer total) {
            this.total = total;
            this.setPages(this.total % this.size > 0 ? this.total / this.size + 1 : this.total / this.size);
        }
    }

案例

ListUserForm

UserServiceImpl

/**
     * 获取用户列表
     * @param listUserForm 表单数据
     * @return 用户列表
     */
    @Override
    public PageVo<UserVo> listUser(ListUserForm listUserForm) {
        PageVo<UserVo> pageVo = new PageVo<UserVo>().setCurrentAndSize(listUserForm);
        pageVo.setTotal(countUser(listUserForm.getStatus()));
        pageVo.setRecords(userMapper.listUser(listUserForm.calcCurrent()));
        return pageVo;
    }
    
    /**
     * 获取用户数量
     * @param status 状态
     * @return 用户数量
     */
    private Integer countUser(String status){
        return count(new QueryWrapper<User>().eq("status",status));
    }

UserController

/**
     * 获取用户列表
     * @param listUserForm 表单数据
     * @return 用户列表
     */
    @ApiOperation("获取用户列表")
    @GetMapping("/listUser")
    @ApiResponses(
            @ApiResponse(code = 200, message = "操作成功", response = UserVo.class)
    )
    public ResultVo listUser(@Validated ListUserForm listUserForm){
        return ResultVoUtil.success(userService.listUser(listUserForm));
    }

![format_png 3][]

注意的点

*  PageVo在实例化的时候需要设置**当前页**和**每页显示的数量** 可以调用`setCurrentAndSize()`完成。
 *  进行分页查询的时候，需要计算偏移量。`listUserForm.calcCurrent()`

为什么要计算偏移量呢？

*  假如查询第1页每页显示10条记录，前端传递过来的参数是`current=1&&size=10`，这个时候`limit 1,10`没有问题。
 *  假如查询第2页每页显示10条记录，前端传递过来的参数是`current=2&&size=10`，这个时候`limit 2,10`就有问题，实际应该是`limit 10,10`。`calcCurrent()的作用就是如此`。

为什么不用MybatisPlus自带的分页插件呢？

> 自带的分页查询在大量数据下，会出现性能问题。

### 常用工具类 ###

常用工具类可以根据自己的开发习惯引入。

--------------------

### 异常处理 ###

异常处理的大致流程主要如下。

*  异常信息抛出 -> `ControllerAdvice` 进行捕获格式化输出内容
 *  手动抛出`CustomException`并传入`ReulstEnum` ——> 进行捕获错误信息输出错误信息。

自定义异常

@Data
    @EqualsAndHashCode(callSuper = false)
    public class CustomException extends RuntimeException {
    
        /**
         * 状态码
         */
        private final Integer code;
    
        /**
         * 方法名称
         */
        private final String method;
    
    
        /**
         * 自定义异常
         *
         * @param resultEnum 返回枚举对象
         * @param method     方法
         */
        public CustomException(ResultEnum resultEnum, String method) {
            super(resultEnum.getMsg());
            this.code = resultEnum.getCode();
            this.method = method;
        }
    
        /**
         * @param code    状态码
         * @param message 错误信息
         * @param method  方法
         */
        public CustomException(Integer code, String message, String method) {
            super(message);
            this.code = code;
            this.method = method;
        }
    
    }

错误信息枚举

根据业务进行添加。

@Getter
    public enum ResultEnum {
    
        /**
         * 未知异常
         */
        UNKNOWN_EXCEPTION(100, "未知异常"),
    
        /**
         * 添加失败
         */
        ADD_ERROR(103, "添加失败"),
    
        /**
         * 更新失败
         */
        UPDATE_ERROR(104, "更新失败"),
    
        /**
         * 删除失败
         */
        DELETE_ERROR(105, "删除失败"),
    
        /**
         * 查找失败
         */
        GET_ERROR(106, "查找失败"),
    
        ;
    
        private Integer code;
    
        private String msg;
    
        ResultEnum(Integer code, String msg) {
            this.code = code;
            this.msg = msg;
        }
    
        /**
         * 通过状态码获取枚举对象
         * @param code 状态码
         * @return 枚举对象
         */
        public static ResultEnum getByCode(int code){
            for (ResultEnum resultEnum : ResultEnum.values()) {
                if(code == resultEnum.getCode()){
                    return resultEnum;
                }
            }
            return null;
        }
    
    }

全局异常拦截

全局异常拦截是使用`@ControllerAdvice`进行实现，常用的异常拦截配置可以查看 GlobalExceptionHandling。

@Slf4j
    @RestControllerAdvice
    public class GlobalExceptionHandling {
    
        /**
         * 自定义异常
         */
        @ExceptionHandler(value = CustomException.class)
        public ResultVo processException(CustomException e) {
            log.error("位置:{} -> 错误信息:{}", e.getMethod() ,e.getLocalizedMessage());
            return ResultVoUtil.error(Objects.requireNonNull(ResultEnum.getByCode(e.getCode())));
        }
    
        /**
         * 通用异常
         */
        @ResponseStatus(HttpStatus.OK)
        @ExceptionHandler(Exception.class)
        public ResultVo exception(Exception e) {
            e.printStackTrace();
            return ResultVoUtil.error(ResultEnum.UNKNOWN_EXCEPTION);
        }
    }

案例

Controller

/**
     * 删除用户
     * @param id 用户编号
     * @return 成功或者失败
     */
    @ApiOperation("删除用户")
    @DeleteMapping("/deleteUser/{id}")
    public ResultVo deleteUser(@PathVariable("id") String id){
        userService.deleteUser(id);
        return ResultVoUtil.success();
    }

Service

/**
     * 删除用户
     * @param id id
     */
    @Override
    public void deleteUser(String id) {
        // 如果删除失败抛出异常。 -- 演示而已不推荐这样干
        if(!removeById(id)){
            throw new CustomException(ResultEnum.DELETE_ERROR, MethodUtil.getLineInfo());
        }
    }

结果

![format_png 4][]

![format_png 5][]

**将报错代码所在的文件第多少行都打印出来。方便排查。**

注意的点

所有手动抛出的错误信息，都应在错误信息枚举`ResultEnum`进行统一维护。不同的业务使用不同的错误码。方便在报错时进行分辨。快速定位问题。

--------------------

### 多环境配置 ###

SpringBoot多环境配置

对于一个项目来讲基本都4有个环境`dev`,`test`,`pre`,`prod`，对于SpringBoot项目多建立几个配置文件就可以了。然后启动的时候可以通过配置`spring.profiles.active` 来选择启动的环境。

![format_png 6][]

java -jar BasicProject.jar --spring.profiles.active=prod

Maven多环境配置

假如想在打包的时候动态指定环境，这个时候就需要借助Maven的xml来实现。

配置XML

<profiles>
        <profile>
            
            <id>dev</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>
                <activatedProperties>dev</activatedProperties>
            </properties>
        </profile>
        <profile>
            
            <id>test</id>
            <properties>
                <activatedProperties>test</activatedProperties>
            </properties>
        </profile>
        <profile>
            
            <id>pre</id>
            <properties>
                <activatedProperties>pre</activatedProperties>
            </properties>
        </profile>
        <profile>
            
            <id>prod</id>
            <properties>
                <activatedProperties>prod</activatedProperties>
            </properties>
        </profile>
    </profiles>

更改application.yml

spring:
      profiles:
        # 选择环境
        active: @activatedProperties@
    复制代码

使用案例

mvn clean package -P prod
    mvn clean package -P pre
    mvn clean package -P test

打包完可以解压开查看`application.yml` 会发现`spring.profiles.active=@activatedProperties@` 发生了改变。

--------------------

### 日志配置 ###

采用logback日志配置

### JenkinsFile ###

JenkinsFile肯定顾名思义是给jenkins用的。主要是配置项目根据如何进行构建并发布到不同的环境。需要去了解pipeline语法，以及如何配置jenkins。JenkinsFileDemo

--------------------

### 代码地址 ###

> https://gitee.com/huangxunhui/basic\_project.git

![a7ca7979f48418aba0bb0eb635911598.gif][]

**推荐阅读：**

1、[项目中常用的19条MySQL优化][19_MySQL]

2、[必须收藏！SpringBoot注解大全][SpringBoot]

3、[分享几个开源的高仿项目， 需要的自取][Link 1]

4、[老板要求用java将word转为PDF，这么搞？][java_word_PDF]

5、[吐血整理！14 个 Spring MVC 顶级技巧！][14 _ Spring MVC]

6、[看过来Mybatis：颠覆你心中对事务的理解][Mybatis]

7、[MySQL：互联网公司常用分库分表方案汇总][MySQL]

8、[卧槽，为什么volatile关键字保证不了线程安全啊][volatile]

9、[这21个刁钻的HashMap 面试题，我把阿里面试官吊打了！][21_HashMap]

10、[Spring Boot “内存泄漏”？看看美团大牛是如何排查的][Spring Boot]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1NjYxMTcx_size_16_color_FFFFFF_t_70][]

[format_png]: /images/20221120/142daec8392149dca5def0272a5c03d4.png
[format_png 1]: /images/20221120/e3086a36006b42478481e42881905aae.png
[format_png 2]: /images/20221120/b3b9961862614d7783293167bd8e8cf7.png
[format_png 3]: /images/20221120/02e89e8bceb1450a98a164d9a40b3338.png
[format_png 4]: /images/20221120/576a292964cc4b2cb998f30e71d20abb.png
[format_png 5]: /images/20221120/3cbb8aa2701442ef9f36402ed5ba41c8.png
[format_png 6]: /images/20221120/ac9eaa98793d4ed89aa74ac8e9b5a848.png
[a7ca7979f48418aba0bb0eb635911598.gif]: /images/20221120/a5b2588a120e45728fa5ada191257299.png
[19_MySQL]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247492315&idx=1&sn=37c6888e30892c7fae56d0769c35a571&chksm=fbc22c17ccb5a501df41ddeaecf0f7e85e292b45d6c7522e4d6a4d9c4a93a389338ee175eae8&scene=21#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493386&idx=1&sn=6014e7fb6c2a43ca8df3b011754fa4e1&chksm=fbc229c6ccb5a0d068fdce76d8e457510c9c43e866952a917ae63ee0f1da8c5c25bd5d3879a2&scene=21#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493242&idx=1&sn=ae4546b8447b8aef71cf68781003b226&chksm=fbc228b6ccb5a1a02f8d036b13a85c7485c048d351afb87a949999c24e0e6863f860289c00a6&scene=21#wechat_redirect
[java_word_PDF]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247492363&idx=1&sn=6975a1a5de92dc49d04654f21ffa7c21&chksm=fbc22dc7ccb5a4d1b94f2a9bbce26082c9f845fbbf7d588a5540d072bcef39b2281d0b705f91&scene=21#wechat_redirect
[14 _ Spring MVC]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493345&idx=1&sn=edde6ca39a12c08acdab32c03e66369e&chksm=fbc2282dccb5a13bb7010d0ba909b021a92c4530bdd515e1449893f1f589bb903915626f15ac&scene=21#wechat_redirect
[Mybatis]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493252&idx=1&sn=54638b598a57683c4b2b9efe3acbe03b&chksm=fbc22848ccb5a15e1e2d2adc63b2e7813b41acdfae07391a86bce775924b57436d7a8ed99218&scene=21#wechat_redirect
[MySQL]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493296&idx=1&sn=d3d9f8bb4d12555f870297ab3c7564e2&chksm=fbc2287cccb5a16a527c08f0d620b4a61a2af45634c895cee2f0d49907684000b43d43973ec6&scene=21#wechat_redirect
[volatile]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247492809&idx=1&sn=47c50b227f8063129ed09edc91449100&chksm=fbc22a05ccb5a31383ee13bb6c58f8c12dada691c16624e028f23f24c32d1e4201b4ebd1a354&scene=21#wechat_redirect
[21_HashMap]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247490277&idx=1&sn=63d44db7ae6930f25478119f423227d4&chksm=fbc1d429ccb65d3fc4be6ab008e4318d3beeccb1394801c72e33cbb9fd162868dce2b9b0c0f2&scene=21#wechat_redirect
[Spring Boot]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ==&mid=2247493061&idx=1&sn=059d8dcf396bb5a4627d47ff4caa2b4f&chksm=fbc22b09ccb5a21f763789682341712c81e967d31949e2ee4d9161f348839c69fbf9d5aab7f2&scene=21#wechat_redirect
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1NjYxMTcx_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201117113552834.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1NjYxMTcx,size_16,color_FFFFFF,t_70