【企业级SpringBoot单体项目模板】—— 一些开发规范

末蓝、 2024-04-23 12:56 75阅读 0赞

>  *  ?**作** **者**：[是江迪呀][Link 1]
>  *  ✒️**本文关键词**：`SpringBoot项目模版`、`企业级`
>  *  ☀️**每日 一言**：`种一棵树最好的时间是十年前，其次是现在！`

上一回我们已经搭建了一个单体`SpringBoot项`目并且做了一些全局的配置、比如全局异常处理、返回体配置。下面我们需要说的是在企业开发中提高代码可读性的一些规范。

#### 文章目录 ####

*  一、命名
 *   *  1.1 类的命名和定义：
     *  1.2 类的命名不要太长：
 *  二、使用RESTful风格
 *   *  2.1 RESFul
     *  2.2 关于控制层命名
 *  三、按照模块分类

> 本节最终目录结构

![在这里插入图片描述][ab31691b642e4688847356ac1b57a8d8.png]

## 一、命名 ##

### 1.1 类的命名和定义： ###

*  **实体类**：和数据库名称保持一致，使用驼峰。
 *  **出入参类：** 入参查询使用QO结尾，其余使用DTO结尾。出参使用VO结尾。查询使用Query开头、新增使用Add开头、删除使用Delete开头、修改使用Update开头，如下所示：  
    ![在这里插入图片描述][784236df44d945619b73669a4b9ea71a.png]

@Data
    public class QueryUserQO {
        
        /**
         * 姓名
         */
        private String name;
    
        /**
         * 年龄
         */
        private Integer age;
    }

@Data
    public class DeleteUserQO {
        
        private Long id;
    }

@Data
    public class UpdateUserQO {
        
        private String name;
        private Integer age;
    }

@Data
    public class AddUserQO {
        
        private String name;
        private Integer age;
    }

### 1.2 类的命名不要太长： ###

比如我需要定义一个企业微信发消息给用户的类命名为：`QywxSendMessageToUserQO`，感觉太长了如果缩减又不能达到见名之意的效果。

怎么办呢？

我们可以将`QywxSendMessage`往上提出来，作为文件夹的名字，那么这个文件夹下面就表示都是企业微信发消息的类，那么我们 可以将`QywxSendMessageToUserQO`缩减为`ToUserQO`：![在这里插入图片描述][c3893a37cfbd4fac8c7516985a98b465.png]  
当然如果你感觉`qywxsendmessage`作为文件夹的名字太长，你可以再分一级：![在这里插入图片描述][431d03bbd24f4dbab6752f99fa6affb6.png]

## 二、使用RESTful风格 ##

### 2.1 RESFul ###

如果你经常在定义接口的`url`时犯难，不知道如何定义这个`url`的名字才比较合适，起早贪黑想终于想好了结果又和其他`url`名称重复了。这太让人无语了！

那么`RESTful`风格绝对值得拥有！做法很简单，你只需要遵循一下两点：

*  **RESTful规则：** `GET（获取资源）`、`POST（创建资源）`、`PUT（更新资源）`、`DELETE（删除资源）`等。
 *  **以资源为驱动规则：** 一切请求都被视为资源，每个资源都有一个唯一的标识符（通常是一个 URL）。这些资源可以是物理实体，也可以是虚拟概念，如数据、服务、文件等。

@RestController
    @RequestMapping("/api")
    public class UserController {
        
        
        private final List<User> userList = new ArrayList<>(); // 用于存放用户的列表
        // 获取所有用户列表
        @GetMapping("/users")
        public ResponseEntity<List<User>> getAllUsers() {
        
            return ResponseEntity.ok(userList);
        }
        // 获取单个用户信息
        @GetMapping("/user/{id}")
        public ResponseEntity<User> getUser(@PathVariable Long id) {
        
            User user = findUserById(id);
            if (user != null) {
        
                return ResponseEntity.ok(user);
            } else {
        
                return ResponseEntity.notFound().build();
            }
        }
        // 创建新用户
        @PostMapping
        public ResponseEntity<User> createUser(@RequestBody User user) {
        
            userList.add(user);
            return ResponseEntity.status(HttpStatus.CREATED).body(user);
        }
        // 更新用户信息
        @PutMapping("/user/{id}")
        public ResponseEntity<User> updateUser(@PathVariable Long id, @RequestBody User updatedUser) {
        
            User user = findUserById(id);
            if (user != null) {
        
                user.setUsername(updatedUser.getUsername());
                user.setEmail(updatedUser.getEmail());
                return ResponseEntity.ok(user);
            } else {
        
                return ResponseEntity.notFound().build();
            }
        }
        // 删除用户
        @DeleteMapping("/user/{id}")
        public ResponseEntity<Void> deleteUser(@PathVariable Long id) {
        
            User user = findUserById(id);
            if (user != null) {
        
                userList.remove(user);
                return ResponseEntity.noContent().build();
            } else {
        
                return ResponseEntity.notFound().build();
            }
        }
    }

### 2.2 关于控制层命名 ###

既然我们使用了RESTful并以资源为驱动的`url`命名风格，那么我们将控制层的名称也可以修改为`Resource`结尾，如：![在这里插入图片描述][972de06664d04c56af090f10f949932b.png]

## 三、按照模块分类 ##

每个模块都要创建属于它自己的文件夹，这样非常方便后期维护管理，会使整个项目看起来更加简洁。我们拿用户模块和订单模块创建的实体类举例：![在这里插入图片描述][105c3d7ad536427a8a1a1bfd4d892a33.png]

[Link 1]: https://blog.csdn.net/qq_42785250?spm=1011.2124.3001.5343
[ab31691b642e4688847356ac1b57a8d8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/a1b29228a1374fb9b3ab47a42b859ed3.png
[784236df44d945619b73669a4b9ea71a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/a04303854d7541a59c6cd660d96d9b5a.png
[c3893a37cfbd4fac8c7516985a98b465.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/abb796a2b1f14085b556fc37702d0a0f.png
[431d03bbd24f4dbab6752f99fa6affb6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/04e59da97a19447f8b7a4ae86eac43e3.png
[972de06664d04c56af090f10f949932b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/eda8e01d9c4b48518ce5500b32df5f54.png
[105c3d7ad536427a8a1a1bfd4d892a33.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/3bcc61e3564b4ebbbb06080dbe6541ae.png