目录
@JsonIgnore@JSONField(serialize = false)
@EnableConfigurationProperties
@EnableConfigurationProperties
@Order(Ordered.HIGHEST_PRECEDENCE)
@Order(Ordered.LOWEST_PRECEDENCE)
@CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy、@Temporal
排除数据库连接注解
(在不需要连接数据库的项目中)
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
//@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
@JsonPropertyOrder
出参JSONObject属性排序
@JsonPropertyOrder(value = {"log_id", "rule_type_name"}, alphabetic = true)
@JsonIgnore
@JSONField(serialize = false)
@PropertySource
用法1:
用法2
@PropertySource(value={"classpath:info.yml"},encoding="utf-8")
@EnableConfigurationProperties
也可以用在方法上,注入到JSONObject中。
/** * @return * @Resource(name = "serviceInfo") * private JSONObject serviceInfo; */ @Bean @ConfigurationProperties(prefix = "cas.service-register") public JSONObject serviceInfo() { return new JSONObject(); }
@ConfigurationProperties
@AutoConfigureAfter
@EnableConfigurationProperties
还有人说要把@EnableConfigurationProperties加到启动类上,上例就不用。
@CookieValue
@cookieValue是springMvc中的注解用来获取Cookie中的值
@CookieValue参数 1、value:参数名称 2、required:是否必须 3、defaultValue:默认值
@GetMapping("verify") //直接获取cookie中的token值
public ResponseEntity<UserInfo> verifyUser(@CookieValue("LY_TOKEN") String token) {
}
@ServletComponentScan
/*
使用@ServletComponentScan注解后
Servlet可以直接通过@WebServlet注解自动注册
Filter可以直接通过@WebFilter注解自动注册
Listener可以直接通过@WebListener注解自动注册
*/
@Order(-1)
@Order(Ordered.HIGHEST_PRECEDENCE)
@Order(Ordered.LOWEST_PRECEDENCE)
//@Order定义了Bean的加载顺序/执行顺序,值越小拥有越高的优先级
例如:@Order(-1)优先于@Order(0),@Order(1)优先于@Order(2)
//@Order(Ordered.HIGHEST_PRECEDENCE)代表这个过滤器在众多过滤器中级别最高,也就是过滤的时候最先执行,而@Order(Ordered.LOWEST_PRECEDENCE)恰恰相反,表示级别最低,最后执行过滤操作。
/**
* 配置SentinelGatewayBlockExceptionHandler,限流后异常处理
* //@Order定义了Bean的加载顺序/执行顺序,值越小拥有越高的优先级
* 例如:@Order(-1)优先于@Order(0),@Order(1)优先于@Order(2)
* //@Order(Ordered.HIGHEST_PRECEDENCE)代表这个过滤器在众多过滤器中级别最高,也就是过滤的时候最先执行
* 而@Order(Ordered.LOWEST_PRECEDENCE)恰恰相反,表示级别最低,最后执行过滤操作。
* @return
*/
@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
public JsonSentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
return new JsonSentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
}
/**
* 配置SentinelGatewayFilter
*
* @return
*/
@Bean
@Order(-1)
public GlobalFilter sentinelGatewayFilter() {
return new SentinelGatewayFilter();
}
@RequiredArgsConstructor
该注解是lombok提供的注解,作用是可以使用finanl写法注入bean
但是使用该注解会存在循环依赖的问题
解决方法:
1.改为@Autowired注解去注入bean,因为@Autowired注解本身就已经解决了循环依赖的问题
2.@RequiredArgsConstructor(onConstructor = @__(@Autowired))
这样写后,还可以用final的写法写,但是默认都是通过@Autowired注入的
3.@RequiredArgsConstructor(onConstructor_ = {@Lazy}) 使用懒加载解决
在spring jpa中,支持在字段或者方法上进行注解
需要在启动类上使用@EnableJpaAuditing启用JPA审计,
需要在实体类上使用@EntityListeners(AuditingEntityListener.class)注解,
@CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy、@Temporal
@Temporal()注解
一般用于实体类,帮助java的Date类型进行格式化
第一种:@Temporal(TemporalType.DATE)——>实体类会封装成“yyyy-MM-dd”的 Date类型。
第二种:@Temporal(TemporalType.TIME)——>实体类会封装成“hh-MM-ss”的Date类型。
第三种:@Temporal(TemporalType.TIMESTAMP)——>默认的,实体会封装成完整的时间“yyyy-MM-dd hh:MM:ss”的Date类型
两种使用方式:
字段上:@LastModifiedDate
@Temporal(TemporalType.TIMESTAMP)
@Column(name = “regist_time”)
private Date registTime;
get方法上:
@Temporal(TemporalType.TIMESTAMP)
public Date getRegistTime(){
return registTime;
}
对于@CreatedBy、@LastModifiedBy 自定义配置类实现AuditorAware
接口,重写getCurrentAuditor方法,给CreatedBy和LastModifiedBy赋值。本代码使用的是Security安全框架,所以通过Security即可获取用户名。
@Configuration
public class UserAuditor implements AuditorAware<String> {
@Override
public Optional<String> getCurrentAuditor() {
UserDetails user;
try {
user = (UserDetails) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
return Optional.ofNullable(user.getUsername());
}catch (Exception e){
return Optional.empty();
}
}
}
@Value注入List、数组、Set、Map
注入List
在日常开发中,经常会遇到需要在配置文件中,存储 List
或是 Map
这种类型的数据。Spring 原生是支持这种数据类型的,以配置 List
类型为例,对于 .yml
文件配置如下:
test:
list:
- aaa
- bbb
- ccc
对于 .properties
文件配置如下所示:
test.list[0]=aaa
test.list[1]=bbb
test.list[2]=ccc
当我们想要在程序中使用时候,想当然的使用 @Value
注解去读取这个值,就像下面这种写法一样:
@Value("${test.list}")
private List testList;
你会发现程序直接报错了,报错信息如下:
java.lang.IllegalArgumentException: Could not resolve placeholder 'test.list' in value "${test.list}"
这个问题也是可以解决的,以我们要配置的 key 为 test.list
为例,新建一个 test
的配置类,将 list
作为该配置类的一个属性:
@Data
@Configuration
@ConfigurationProperties("test")
public class TestListConfig {
private List list;
}
在程序其他地方使用时候。采用自动注入的方式,去获取值:
@Autowired
private TestListConfig testListConfig;
// testListConfig.getList();
可以看见,这种方式十分的不方便,最大的问题是配置和代码高耦合了,增加一个配置,还需要对配置类做增减改动。
注入数组
数组?说实话,业务代码写多了,这个“古老”的数据结构远远没有 list 用的多,但是它在解决上面这个问题上,出乎异常的好用。
test:
array1: aaa,bbb,ccc
array2: 111,222,333
array3: 11.1,22.2,33.3
@Value("${test.array1}")
private String[] testArray1;
@Value("${test.array2}")
private int[] testArray2;
@Value("${test.array3}")
private double[] testArray3;
这样就能够直接使用了,就是这么的简单方便,如果你想要支持不配置 key 程序也能正常运行的话,给它们加上默认值即可:
@Value("${test.array1:}")
private String[] testArray1;
@Value("${test.array2:}")
private int[] testArray2;
@Value("${test.array3:}")
private double[] testArray3;
仅仅多了一个 : 号,冒号后的值表示当 key 不存在时候使用的默认值,使用默认值时数组的 length = 0。总结下使用数组实现的优缺点:
优点:
- 不需要写配置类
- 使用逗号分割,一行配置,即可完成多个数值的注入,配置文件更加精简
缺点:
- 业务代码中数组使用很少,基本需要将其转换为 List,去做 contains、foreach 等操作。
使用EL表达式解析配置
那么我们有没有办法,在解析 list、map 这些类型时,
@Value("#{'${test.list}'.split(',')}")
private List testList;
像数组一样方便呢?
答案是可以的,这就依赖于 EL
表达式。
解析List
以使用 .yml
文件为例,我们只需要在配置文件中,跟配置数组一样去配置:
test:
list: aaa,bbb,ccc
在调用时,借助 EL
表达式的 split()
函数进行切分即可:
@Value("#{'${test.list}'.split(',')}")
private List testList;
同样,为它加上默认值,避免不配置这个 key 时候程序报错:
@Value("#{'${test.list:}'.split(',')}")
private List testList;
但是这样有个问题,当不配置该 key 值,默认值会为空串,它的 length = 1(不同于数组,length = 0),这样解析出来 list 的元素个数就不是空了。
这个问题比较严重,因为它会导致代码中的判空逻辑执行错误。这个问题也是可以解决的,在 split()
之前判断下是否为空即可:
@Value("#{'${test.list:}'.empty ? null : '${test.list:}'.split(',')}")
private List testList;
如上所示,即为最终的版本,它具有数组方式的全部优点,且更容易在业务代码中去应用。
解析 Set
解析 Set 和解析 List 本质上是相同的,唯一的区别是 Set 会做去重操作。
test:
set: 111,222,333,111
@Value("#{'${test.set:}'.empty ? null : '${test.set:}'.split(',')}")
private Set testSet;
// output: [111, 222, 333]
解析Map
解析 Map 的写法如下所示,value 为该 map 的 JSON 格式,注意这里使用的引号:整个 JSON 串使用引号包裹,value 值使用引号包裹。
test:
map1: '{"name": "zhangsan", "sex": "male"}'
map2: '{"math": "90", "english": "85"}'
在程序中,利用 EL 表达式注入:
@Value("#{${test.map1}}")
private Map map1;
@Value("#{${test.map2}}")
private Map map2;
注意,使用这种方式,必须得在配置文件中配置该 key 及其 value。
如果你真的很需要这个功能,就得自己写解析方法了,这里以使用 fastjson 进行解析为例:
自定义解析方法:
public class MapDecoder {
public static Map decodeMap(String value) {
try {
return JSONObject.parseObject(value, new TypeReference>(){});
} catch (Exception e) {
return null;
}
}
}
在程序中指定解析方法:
@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map1:}')}")
private Map map1;
@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map2:}')}")
private Map map2;