harmony-life-server/README.md
2024-10-08 20:48:51 +08:00

42 lines
2.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 参考资料
AntDesignProhttps://pro.antdv.com/docs/getting-started
sa-token 文档https://sa-token.cc/doc.html#/
Knife4j 文档 https://doc.xiaominfo.com/
雪花算法 https://github.com/yitter/idgenerator/tree/master/Java
波市科技文献共享服务平台https://www.nbsti.net/Public/html/index.html
lambok:
```
@Data 标签生成getter/setter toString()等方法
@NonNull : 让你不在担忧并且爱上NullPointerException
@CleanUp : 自动资源管理不用再在finally中添加资源的close方法
@Setter/@Getter : 自动生成set和get方法
@ToString : 自动生成toString方法
@EqualsAndHashcode : 从对象的字段中生成hashCode和equals的实现
@NoArgsConstructor/@RequiredArgsConstructor/@AllArgsConstructor
自动生成构造方法
@Data : 自动生成set/get方法toString方法equals方法hashCode方法不带参数的构造方法
@Value : 用于注解final类
@Builder : 产生复杂的构建器api类
@SneakyThrows : 异常处理(谨慎使用)
@Synchronized : 同步方法安全的转化
@Getter(lazy=true) :
@Log : 支持各种logger对象使用时用对应的注解@Log4j
```
### 目录结构
- config里面存放的都是配置类 例如 @Configuration@Component 等等
- controller里面存放的是接口(术语存放所有处理HTTP请求的控制器类。这些类通过定义路由和方法来处理前端发送的请求并返回响应。)
- service里面存放的是接口对应的服务术语定义业务逻辑接口这些接口定义了业务操作的抽象与数据访问层DAO或Repository解耦
- impl里面存放服务的具体实现术语这个子目录存放service接口的具体实现。这里通常包含对业务逻辑的具体实现可能会调用数据访问层的方法来完成数据操作。
- util存放工具类这些类通常包含静态方法用于执行通用任务如日期时间处理、加密解密、日志记录等。
- mappermapper接口用于定义数据访问层的方法这些方法通常直接映射到数据库操作。映射文件xml
- domain: 存放与数据库表相对应的实体类Entity、数据传输对象DTO和视图对象VO
- dto: 里面的对象一同来接收前端传来的参数(数据传输对象,用于不同层之间传输数据,特别是跨系统或跨模块传输时,可能需要根据需要进行数据封装。)
- entity实体类与数据库表结构一一对应用于ORM映射。
- vo视图对象通常用于返回给前端的数据封装可以包含多个实体类的属性或仅包含部分实体类的属性。