5. 读取配置信息
很多时候我们需要将一些常用的配置信息比如阿里云 oss、发送短信、微信认证的相关配置信息等等放到配置文件中。
下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。
我们的数据源application.yml内容如下：
wuhan2020: 但是，我相信一切都会过去！武汉加油！中国加油！ my-profile: name: Guide哥 email: koushuangbwcx@163.com library: location: 湖北武汉加油中国加油 books: - name: 天才基本法 description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校，恰是父亲当年为她放弃的那所。 - name: 时间的秩序 description: 为什么我们记得过去，而非未来？时间“流逝”意味着什么？是我们存在于时间之内，还是时间存在于我们之中？卡洛·罗韦利用诗意的文字，邀请我们思考这一亘古难题——时间的本质。 - name: 了不起的我 description: 如何养成一个新
5.1. @value(常用)
使用 @Value("${property}") 读取比较简单的配置信息：
@Value("${wuhan2020}") String wuhan2020;
5.2. @ConfigurationProperties(常用)
通过@ConfigurationProperties读取配置信息并与 bean 绑定。
@Component @ConfigurationProperties(prefix = "library") class LibraryProperties { @NotEmpty private String location; private List<Book> books; @Setter @Getter @ToString static class Book { String name; String description; } 省略getter/setter ...... }
5.3. PropertySource（不常用）
@PropertySource读取指定 properties 文件
@Component @PropertySource("classpath:website.properties") class WebSite { @Value("${url}") private String url; 省略getter/setter ...... }
6. 参数校验
数据的校验的重要性就不用说了，即使在前端对数据进行校验的情况下，我们还是要对传入后端的数据再进行一遍校验，避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请求一些违法数据。
JSR(Java Specification Requests） 是一套 JavaBean 参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们 JavaBean 的属性上面，这样就可以在需要校验的时候进行校验了，非常方便！
校验的时候我们实际用的是 Hibernate Validator 框架。Hibernate Validator 是 Hibernate 团队最初的数据校验框架，Hibernate Validator 4.x 是 Bean Validation 1.0（JSR 303）的参考实现，Hibernate Validator 5.x 是 Bean Validation 1.1（JSR 349）的参考实现，目前最新版的 Hibernate Validator 6.x 是 Bean Validation 2.0（JSR 380）的参考实现。
SpringBoot 项目的 spring-boot-starter-web 依赖中已经有 hibernate-validator 包，不需要引用相关依赖。如下图所示（通过 idea 插件—Maven Helper 生成）：
6.1. 一些常用的字段验证的注解
- @NotEmpty 被注释的字符串的不能为 null 也不能为空
- @NotBlank 被注释的字符串非 null，并且必须包含一个非空白字符
- @Null 被注释的元素必须为 null
- @NotNull 被注释的元素必须不为 null
- @AssertTrue 被注释的元素必须为 true
- @AssertFalse 被注释的元素必须为 false
- @Pattern(regex=,flag=)被注释的元素必须符合指定的正则表达式
- @Email 被注释的元素必须是 Email 格式。
- @Min(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值
- @Max(value)被注释的元素必须是一个数字，其值必须小于等于指定的最大值
- @DecimalMin(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值
- @DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
- @Size(max=, min=)被注释的元素的大小必须在指定的范围内
- @Digits (integer, fraction)被注释的元素必须是一个数字，其值必须在可接受的范围内
- @Past被注释的元素必须是一个过去的日期
- @Future 被注释的元素必须是一个将来的日期
- 详情可以看我这篇文章：
- Spring中@NotEmpty、@NotBlank、@NotNull 区别和使用_linxiMY的博客-CSDN博客
- 适用于基本数据类型(Integer，Long，Double等等)，当 @NotNull 注解被使用在 String 类型的数据上，则表示该数据不能为 Null（但是可以为 Empty）注：被其标注的字段可以使用 @size、@Max、@Min 对字段数值进行大小的控制适用于 String 类型的数据上，加了@NotBlank 注解的参数不能为 Null 且 trim() 之后 size > 0，必须有实际字符@NotEmpty。
6.2. 验证请求体(RequestBody)
@Data @AllArgsConstructor @NoArgsConstructor public class Person { @NotNull(message = "classId 不能为空") private String classId; @Size(max = 33) @NotNull(message = "name 不能为空") private String name; @Pattern(regexp = "((^Man$|^Woman$|^UGM$))", message = "sex 值不在可选范围") @NotNull(message = "sex 不能为空") private String sex; @Email(message = "email 格式不正确") @NotNull(message = "email 不能为空") private String email; }
我们在需要验证的参数上加上了@Valid注解或者@Validated(实体类上添加啊注解，controller类接收参数时使用上@Valid注解或者@Validated ，，，，，，必须同时使用才能生效)，如果验证失败，它将抛出MethodArgumentNotValidException。
@RestController @RequestMapping("/api") public class PersonController { @PostMapping("/person") public ResponseEntity<Person> getPerson(@RequestBody @Valid Person person) { return ResponseEntity.ok().body(person); } }
6.3. 验证请求参数(Path Variables 和 Request Parameters)
@RestController @RequestMapping("/api") @Validated public class PersonController { @GetMapping("/person/{id}") public ResponseEntity<Integer> getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超过 id 的范围了") Integer id) { return ResponseEntity.ok().body(id); } }
7. 全局处理 Controller 层异常
介绍一下我们 Spring 项目必备的全局处理 Controller 层异常。
相关注解：
- @ControllerAdvice :注解定义全局异常处理类
- @ExceptionHandler :注解声明异常处理方法
如何使用呢？拿我们在第 5 节参数校验这块来举例子。如果方法参数不对的话就会抛出MethodArgumentNotValidException，我们来处理这个异常。
示例：
@ControllerAdvice @ResponseBody public class GlobalExceptionHandler { /** * 请求参数异常处理 */ @ExceptionHandler(MethodArgumentNotValidException.class) public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) { ...... } }
例子：
@RestControllerAdvice @Slf4j public class ExceptionControllerAdvice { @ExceptionHandler(value = MethodArgumentNotValidException.class) public Result handleValidException(MethodArgumentNotValidException e) { log.error("数据校验出现问题{}，异常类型{}", e.getMessage(), e.getClass()); BindingResult bindingResult = e.getBindingResult(); HashMap<String, Object> errorMap = new HashMap<>(); bindingResult.getFieldErrors().forEach(item->{ System.out.println(item); errorMap.put(item.getField(), item.getDefaultMessage()); }); return Result.fail(404,String.valueOf(errorMap)); } }
8. 事务 @Transactional
在要开启事务的方法上使用@Transactional注解即可!
可以放在类上，也可放在方法中：
@Transactional(rollbackFor = Exception.class)
我们知道 Exception 分为运行时异常 RuntimeException 和非运行时异常。在@Transactional注解中如果不配置rollbackFor属性,那么事物只会在遇到RuntimeException的时候才会回滚,加上rollbackFor=Exception.class,可以让事物在遇到非运行时异常时也回滚。
@Transactional 注解一般用在可以作用在 类 或者 方法 上。
- 作用于类：当把@Transactional 注解放在类上时，表示所有该类的public 方法都配置相同的事务属性信息。
- 作用于方法：当类配置了@Transactional，方法也配置了@Transactional，方法的事务会覆盖类的事务配置信息。
9. json 数据处理
10.1. 过滤 json 数据
@JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析。
//生成json时将userRoles属性过滤 @JsonIgnoreProperties({"userRoles"}) public class User { private String userName; private String fullName; private String password; @JsonIgnore private List<UserRole> userRoles = new ArrayList<>(); }
@JsonIgnore一般用于类的属性上，作用和上面的@JsonIgnoreProperties 一样。
public class User { private String userName; private String fullName; private String password; //生成json时将userRoles属性过滤 @JsonIgnore private List<UserRole> userRoles = new ArrayList<>(); }
10.2. 格式化 json 数据
@JsonFormat一般用来格式化 json 数据。：
比如：
@JsonFormat(shape=JsonFormat.Shape.STRING, pattern="yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", timezone="GMT") private Date date;
@ApiModelProperty("打卡时间") @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8") private Date dakaTime;
10.3. 扁平化对象
@Getter @Setter @ToString public class Account { @JsonUnwrapped private Location location; @JsonUnwrapped private PersonInfo personInfo; @Getter @Setter @ToString public static class Location { private String provinceName; private String countyName; } @Getter @Setter @ToString public static class PersonInfo { private String userName; private String fullName; } }
未扁平化之前：
{ "location": { "provinceName":"湖北", "countyName":"武汉" }, "personInfo": { "userName": "coder1234", "fullName": "shaungkou" } }
使用@JsonUnwrapped 扁平对象之后：
@Getter @Setter @ToString public class Account { @JsonUnwrapped private Location location; @JsonUnwrapped private PersonInfo personInfo; ...... }
{ "provinceName":"湖北", "countyName":"武汉", "userName": "coder1234", "fullName": "shaungkou" }
11. 测试相关
@ActiveProfiles一般作用于测试类上， 用于声明生效的 Spring 配置文件。
@SpringBootTest(webEnvironment = RANDOM_PORT) @ActiveProfiles("test") @Slf4j public abstract class TestBase { ...... }
@Test声明一个方法为测试方法
@Transactional被声明的测试方法的数据会回滚，避免污染测试数据。
@WithMockUser Spring Security 提供的，用来模拟一个真实用户，并且可以赋予权限。
@Test @Transactional @WithMockUser(username = "user-id-18163138155", authorities = "ROLE_TEACHER") void should_import_student_success() throws Exception { ...... }
12：自定义注解（可以通过redis实现，也可以通过切面实现）
下面是一个示例：
@RepeatSubmit
package com.shijiu.annotation; import java.lang.annotation.*; /** * @Author * @Date Created in 2023/4/11 11:36 * @DESCRIPTION: 自定义注解解决重复提交接口 * @Version V1.0 */ @Inherited @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RepeatSubmit { /** * 间隔时间(ms)，小于此时间视为重复提交 */ public int interval() default 1000; /** * 提示消息 */ public String message() default "不允许重复提交，请稍候再试"; }
切面类：RepeatSubmitAspect.java
package com.shijiu.aop; import com.shijiu.annotation.RepeatSubmit; import com.shijiu.vo.Result; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.stereotype.Component; import java.lang.reflect.Method; import java.util.Arrays; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; /** * @Author * @Date Created in 2023/4/11 11:40 * @DESCRIPTION: 限制 一段时间可以请求的次数 * @Version V1.0 */ @Aspect @Component public class RepeatSubmitAspect { private static final Map<String, Long> REQUEST_TIME_MAP = new ConcurrentHashMap<>(); @Around("@annotation(repeatSubmit)") public Object around(ProceedingJoinPoint point, RepeatSubmit repeatSubmit) throws Throwable { Object result = null; MethodSignature signature = (MethodSignature) point.getSignature(); Method method = signature.getMethod(); String key = method.getName() + ":" + Arrays.toString(point.getArgs()); Long requestTime = REQUEST_TIME_MAP.get(key); long currentTime = System.currentTimeMillis(); if (requestTime == null || currentTime - requestTime >= repeatSubmit.interval()) { result = point.proceed(); REQUEST_TIME_MAP.put(key, currentTime); } else { return Result.fail(201,repeatSubmit.message()); } return result; } }
效果图：
补充：
13、Spring Cloud
1、@EnableEurekaServer
用在springboot启动类上，表示这是一个eureka服务注册中心；
2、@EnableDiscoveryClient
用在springboot启动类上，表示这是一个服务，可以被注册中心找到；
3、@LoadBalanced
开启负载均衡能力；
4、@EnableCircuitBreaker
用在启动类上，开启断路器功能；
5、@HystrixCommand(fallbackMethod=”backMethod”)
用在方法上，fallbackMethod指定断路回调方法；
6、@EnableConfigServer
用在启动类上，表示这是一个配置中心，开启Config Server
7、@EnableZuulProxy
开启zuul路由，用在启动类上；
8、@SpringCloudApplication
@SpringBootApplication
@EnableDiscovertyClient
@EnableCircuitBreaker
分别是SpringBoot注解、注册服务中心Eureka注解、断路器注解。对于SpringCloud来说，这是每一微服务必须应有的三个注解，所以才推出了@SpringCloudApplication这一注解集合。
等。。。。。。。。。。。。。。。。。。。
