Springboot(四十八)使用Lombok来优雅的编码

前言
Lombok 是一种 Java™ 实用工具,可用来帮助开发人员消除 Java 的冗长,尤其是对于简单的 Java 物件(POJO)。它通过注解实现这一目的。
正文
新增依赖
在 pom.xml 档案中新增相关依赖:
1.16.20
org.projectlombok
lombok
${lombok.version}
provided
安装外挂
由于 Lombok 采取的注解形式的,在编译后,自动生成相应的方法,为了不让 ide 疯了,需要下载外挂了支援它。
以 idea 为例:查询外挂 lombok plugin 安装即可。
用我的 User 实体类为例(set,get,toString 方法),
@Getter
@Setter
@ToString
public class SysUserEntity implements Serializable
在按快捷键 Ctrl + F12,可以查询到set,get,toString 方法。
注解
写点常用的,其余的 api 的开启 Jar 包一目了然
@Getter
@Setter
@ToString
@EqualsAndHashCode
建构函式
@AllArgsConstructor
会生成一个包含所有变数,同时如果变数使用了NotNull annotation , 会进行是否为空的校验,
全部引数的建构函式的自动生成,该注解的作用域也是只有在实体类上,引数的顺序与属性定义的顺序一致。
@NoArgsConstructor
无参建构函式
@RequiredArgsConstructor
会生成一个包含常量(final),和标识了@NotNull的变数 的构造方法。
怎么使用
它们都有三个引数可以设定
1. String staticName() default "";
如果设定了它,将原来的构造方法的访问修饰符将会变成 私有的,而外新增一个静态构造方法,引数相同,名字是设定的字串的名字,访问修饰符为公有的。
AnyAnnotation[] onConstructor() default {};在构造方法上新增注解。使用方法@RequiredArgsConstructor([email protected]__({@AnnotationsGoHere}))}例如我们在 Spring 专案中需要注入多个值,写很多个 @Autowired 很麻烦,就可以使用这种方式:@Service
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class UserServiceImpl implements IUserService {
private final IUserRepository userRepository;
private final IOrderRepository orderRepository;
………………
AccessLevel access() default lombok.AccessLevel.PUBLIC;建构函式访问修饰符;@NoArgsConstructor无参建构函式中还有个注解 boolean force() default false;作者的注释是 If {@code true}, initializes all final fields to 0 / null / false. Otherwise, a compile time error occurs.设定为 true 的时候,初始化所有的引数为预设值,否则编译错误。@Data
我自己尝试了下,我们使用 @Data 注解就可以有下面几个注解的功能: @ToString、@Getter、@Setter、@EqualsAndHashCode、@NoArgsConstructor 。
注意的是,同时使用@Data 和 @AllArgsConstructor 后 ,预设的无参建构函式失效,如果需要它,要重新设定 @NoArgsConstructor
@Slf4j
//类上面注解了,直接呼叫 log 即可:
log.info(xxxx);
@Log
使用的是 java.util.logging.Logger ,直接使用 变数 log。
@Builder
bulder 模式构建物件。
@Cleanup
@Cleanup
InputStream in = new FileInputStream(args[0]);
@Cleanup
OutputStream out = new FileOutputStream(args[1]);
自动化关闭流,相当于 jdk1.7 种的 try with resource
val
型别推导。
val example = new ArrayList();
example.add("Hello, World!");
对应的转换后代码就是:
val example = new ArrayList();
example.add("Hello, World!");
@NonNull
public NonNullExample(@NonNull Person person) {
this.name = person.getName();
}
转换后就是:
public NonNullExample(@NonNull Person person) {
if (person == null) {
throw new NullPointerException("person");
}
this.name = person.getName();
}
@SneakyThrows
翻译就是暗中丢掷异常
当我们需要丢掷异常,在当前方法上呼叫,不用显示的在方法名后面写 throw
@SneakyThrows(Exception.class)
@Synchronized
方法中所有的程式码都加入到一个程式码块中,预设静态方法使用的是全域性锁,普通方法使用的是物件锁,当然也可以指定锁的物件。
private final Object lock = new Object();
@Synchronized("lock")
public void foo() {
// Do something
}
个人认为这样的阅读起来比较麻烦,实际开发中往往将 synchronized 颗粒化到程式码块中。