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

  •           :是江迪呀
  • ✒️本文关键词SpringBoot项目模版企业级
  • ☀️每日   一言种一棵树最好的时间是十年前,其次是现在!

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

文章目录

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

本节最终目录结构

【企业级SpringBoot单体项目模板 】—— 一些开发规范_第1张图片

一、命名

1.1 类的命名和定义:

  • 实体类:和数据库名称保持一致,使用驼峰。
  • 出入参类: 入参查询使用QO结尾,其余使用DTO结尾。出参使用VO结尾。查询使用Query开头、新增使用Add开头、删除使用Delete开头、修改使用Update开头,如下所示:
    【企业级SpringBoot单体项目模板 】—— 一些开发规范_第2张图片
@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在这里插入图片描述
当然如果你感觉qywxsendmessage作为文件夹的名字太长,你可以再分一级:在这里插入图片描述

二、使用RESTful风格

2.1 RESFul

如果你经常在定义接口的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结尾,如:在这里插入图片描述

三、按照模块分类

每个模块都要创建属于它自己的文件夹,这样非常方便后期维护管理,会使整个项目看起来更加简洁。我们拿用户模块和订单模块创建的实体类举例:【企业级SpringBoot单体项目模板 】—— 一些开发规范_第3张图片

你可能感兴趣的:(项目搭建,spring,boot,后端,java)