spring Boot必用依赖框架

Posted 2023-02-16

参考技术A

使用Lombok框架

在编写POJO类型（包括实体类、VO、DTO等）时，都有统一的编码规范 ，例如：

由于以上操作方式非常固定，且涉及的代码量虽然不难，但是篇幅较长，并且，当类中的属性需要修改时（包括修改原有属性、或增加新属性、删除原有属性），对应的其它方法都需要修改（或重新生成），管理起来比较麻烦。

在Spring Boot中， 添加Lombok依赖 ，可以在创建项目时勾选，也可以后期自行添加，依赖项的代码为：

完成后，在各POJO类型中，将不再需要在源代码添加Setters & Getters、`equals()`、`hashCode()`、`toString()`这些方法， 只需要在POJO类上添加 `@Data` 注解即可 ！

当添加`@Data`注解，且删除相关方法后，由于源代码中没有相关方法，则调用了相关代码的方法可能会报错，但是，并不影响程序运行！

为了避免IntelliJ IDEA判断失误而提示了警告和错误， 推荐安装Lombok插件 ，可参考：

【注】： 无论是否安装插件，都不影响代码的编写和运行！

Slf4j日志框架

在开发实践中， 不允许 使用` System.out.println() `或类似的输出语句来输出显示关键数据（ 核心数据、敏感数据等 ），因为，如果是这样使用，无论是在开发环境，还是测试环境，还是生产环境中，这些输出语句都将输出相关信息，而删除或添加这些输出语句的操作成本比较高，操作可行性低。

推荐 的做法是使用日志框架来输出相关信息！

在Slf4j日志框架中，将日志的可显示级别根据其重要程度（ 严重程度 ）由低到高分为：

在配置文件中，可以通过`logging.level.包名.类名`来设置当前类的日志显示级别，例如：

当设置了显示的日志级别后，仅显示设置级别和更重要的级别的日志，例如，设置为`info`时，只显示`info`、`warn`、`error`，不会显示`debug`、`trace`级别的日志！

当输出日志时，通过`log`变量调用`trace()`方法输出的日志就是`trace`级别的，调用`debug()`方法输出的日志就是`debug()`级别的，以此类推，可调用的方法还有`info()`、`warn()`、`error()`。

在开发实践中， 关键数据和敏感数据都应该通过`trace()`或`debug()`进行输出 ，在开发环境中，可以将日志的显示级别设置为`trace`，则会显示所有日志，当需要交付到生产环境中时，只需要将日志的显示级别调整为`info`即可！

默认情况下，日志的显示级别是`info`，所以，即使没有在配置文件中进行正确的配置，所有info、warn、error级别的日志都会输出显示。

在使用Slf4j时，通过`log`调用的每种级别的方法都被重载了多次（各级别对应除了方法名称不同，重载的次数和参数列表均相同），推荐使用的方法是参数列表为`(String format, Object... arguments)`的，例如：

以上方法中， 第1个参数是将要输出的字符串的模式（模版） ，在此字符串中，如果需要包含某个变量值，则 使用``表示 ，如果有多个变量值，均是如此，然后，再通过第2个参数（是可变参数）依次表示各``对应的值，例如：

使用这种做法，可以避免多变量时频繁的拼接字符串，另外，日志框架会将第1个参数进行缓存，以此提高后续每一次的执行效率。

在开发实践中，应该对程序执行 关键位置添加日志 的输出，通常包括：

其实， Slf4j日志框架只是 日志 的一种 标准 ，并不是具体的实现（感觉上与Java中的接口有点相似），常见有具体实现了日志功能的框架有log4j、logback等，为了统一标准，所以才出现了Slf4j，同时，由于log4j、logback等框架实现功能并不统一，所以，Slf4j提供了对主流日志框架的兼容，在Spring Boot工程中，`spring-boot-starter`就已经依赖了`spring-boot-starter-logging`，而在此依赖下，通常包括Slf4j、具体的日志框架、Slf4j对具体日志框架的兼容。

密码加密( 额外知识点 )

【这并不是Spring Boot框架的知识点】

对密码进行加密，可以有效的保障密码安全，即使出现数据库泄密，密码安全也不会受到影响！ 为了实现此目标，需要在对密码进行加密时， 使用不可逆的算法进行处理！

通常，不可以使用加密算法对密码进行加密码处理，从严格定义上来看，所有的加密算法都是可以逆向运算的，即同时存在加密和解密这2种操作，加密算法只能用于保证传输过程的安全，并不应该用于保证需要存储下来的密码的安全！

哈希算法都是不可逆的，通常，用于处理密码加密的算法中，典型的是一些 消息摘要算法 ，例如 MD5、SHA256 或以上位数的算法。

消息摘要算法的主要特征有 ：

在消息摘要算法中，以MD5为例，其运算结果是一个128位长度的二进制数，通常会转换成十六进制数显示，所以是32位长度的十六进制数，MD5也被称之为128位算法。理论上，会存在2的128次方种类的摘要结果，且对应2的128次方种不同的消息，如果在未超过2的128次方种消息中，存在2个或多个不同的消息对应了相同的摘要，则称之为：发生了碰撞。一个消息摘要算法是否安全，取决其实际的碰撞概率，关于消息摘要算法的破解，也是研究其碰撞概率。

存在穷举消息和摘要的对应关系 ，并利用摘要在此对应关系进行查询，从而得知消息的做法，但是，由于MD5是128位算法，全部穷举是不可能实现的，所以，只要原始密码（消息）足够复杂，就不会被收录到所记录的对应关系中去！

为了进一步提高密码的安全性，在使用 消息摘要算法 进行处理时， 通常还会加盐！ 盐值可以是任意的字符串，用于与密码一起作为被消息摘要算法运算的数据即可，例如：

加盐的目的 是使得被运算数据变得更加复杂，盐值本身和用法并没有明确要求！

甚至，在某些用法或算法中，还会使用随机的盐值，则可以使用完全相同的原消息对应的摘要却不同！

> 推荐了解：预计算的 哈希链 、 彩虹表 、 雪花算法 。

为了进一步保证密码安全，还可以使用多重加密，即反复调用消息摘要算法。

除此以外，还可以使用安全系数更高的算法，例如SHA-256是256位算法，SHA-384是384位算法，SHA-512是512位算法。

Validation框架

当客户端向服务器提交请求时，如果 请求数据出现 明显的问题（例如关键数据为`null`、字符串的长度不在可接受范围内、其它 格式错误 ），应该直接响应错误，而不是将明显错误的请求参数传递到Service！

> 关于判断错误，只有涉及数据库中的数据才能判断出结果的，都由Service进行判断，而基本的格式判断，都由Controller进行判断 。

Validation框架是专门用于解决 检查数据基本格式有效性 的，最早并不是Spring系列的框架，目前，Spring Boot提供了更好的支持，所以，通常结合在一起使用。

在Spring Boot项目中，需要添加`spring-boot-starter-validation` 依赖项 ，例如：

在控制器中，首先，对需要检查数据格式的请求参数添加 `@Valid` 或 `@Validated` 注解（这2个注解没有区别），例如：

真正需要检查的是 `AdminAddNewDTO`中各属性的值 ，所以，接下来需要在此类的各属性上通过注解来配置检查的规则，例如：

重启项目，通过不提交用户名的URL（例如：http://localhost:8080/admins/add-new）进行访问，在浏览器上会出现400错误页面，并且，在IntelliJ IDEA的控制台会出现以下警告：

从警告信息中可以看到，当验证失败时（不符合所使用的注解对应的规则时），会出现`org. springframework.validation.BindException `异常，则自行处理此异常即可！

首先，在`State`中添加新的枚举：

然后，在`GlobalExceptionHandler`中添加新的处理异常的方法：

关于错误提示信息，以上内容中出现了`不能为null`的字样，是默认的提示文本，可以通过` @NotNull`注解的 `message` 属性进行配置 ，例如：

然后，在处理异常时，通过异常信息获取自定义的提示文本：

再次运行，在不提交用户名和密码的情况下，会随机的提示用户名或密码验证失败的提示文本中的某1条。

在Validation框架中 ，还有其它许多注解，用于进行不同格式的验证，例如：

以上注解，包括`@NotNull`是 允许叠加使用 的，即允许在同一个参数属性上添加多个注解！

以上注解均可以配置 `message` 属性，用于指定验证失败的提示文本。

通常：（开发中）