lombok的使用(一)
eclipse安装lombok插件
出现以下画面eclipse 中的lombok安装成功,重启eclipse
在maven项目中使用lombok
1、在maven中添加jar包依赖
在IDEA中使用lombok
在IDEA中安装插件lombok
快速入门lombok
@Slf4j
打印日志,把该注解标记在需要打印日志的java
类名上
package com.demo;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
public static void main(String[] args) {
log.debug("debug模式");
log.info("info模式");
log.warn("warn模式");
log.error("error模式");
log.trace("trace模式");
}
}
程序运行之后的执行结果
其他的像@XSlf4j
、@Log
、@Log4j2
、@CommonsLog
、@JBossLog
也都是lombok
集成的日志框架
@Getter
相当于java中属性的getter
方法
package com.demo;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
@Getter
private static class User{
private String name;
private Integer age;
private Byte sex;
}
}
添加该注解之后,在IDEA
中可以看到获取属性的get方法,如getName()
、getAge()
、getSex
等
@Setter
相当于java中属性的setter
方法
package com.demo;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
@Getter
@Setter
private static class User{
private String name;
private Integer age;
private Byte sex;
}
}
添加该注解之后,在IDEA
中可以看到获取属性的get方法,如setName()
、setAge()
、setSex
等
@EqualsAndHashCode
java中的equals
和hashCode
的
package com.demo;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
@Getter
@Setter
// of 指定哪些字段是参与equals和hashCode的
@EqualsAndHashCode(of = {"name", "age"})
private static class User{
private String name;
private Integer age;
private Byte sex;
}
}
添加注解后,可以在IDEA
中看到equals()
和hashCode()
方法
@ToString
相当于java中原来实体类的toString()
方法
package com.demo;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
@Getter
@Setter
// of 指定哪些字段是参与equals和hashCode的
@EqualsAndHashCode(of = {"name", "age"})
// of 指定哪些字段是可以配置在toString中
@ToString(of = {"name", "age"})
private static class User{
private String name;
private Integer age;
private Byte sex;
}
}
添加注解后,可以在IDEA
中看到toString()
方法
@Data
package com.demo;
import lombok.*;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
@Data
private static class User{
private String name;
private Integer age;
}
}
@Data 注解会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法。
相当于 @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode这几个注解合在一起的效果
@AllArgsConstructor
全参构造函数
package com.demo;
import lombok.*;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
/**
* @AllArgsConstructor 全参构造函数
*/
@AllArgsConstructor
private static class User{
private String name;
private Integer age;
}
}
添加注解后,可以在IDEA
中可以看到User
类的有参构造方法
@NoArgsConstructor
无参构造方法
package com.demo;
import lombok.*;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
/**
* @NoArgsConstructor 无参构造函数
* access 指定访问的级别
* AccessLevel.PRIVATE 属性私有,不被外界使用
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
private static class User{
private String name;
private Integer age;
}
}
添加注解后,可以在IDEA
中可以看到User
类的无参构造方法User()
方法
@Value
用于创建一个不可变的类。当应用于类时,它有以下效果:
- 字段默认为
private
和final
:所有直接在类中声明的字段都会被隐式地声明为private
和final
,这意味着一旦赋值后,就不能再更改 - 无
setter
方法:Lombok不会生成setter
方法,因为final字段不能通过方法进行修改 - 带参数的构造器:Lombok会生成一个构造器,该构造器接受所有字段作为参数,用于初始化对象
getter
方法:为所有字段生成getter
方法,以便于访问这些不可变的属性- 自动实现
equals()
和hashCode()
:如果未指定,Lombok会基于类的字段生成equals()
和hashCode()
方法。这两个方法会根据类的字段内容判断两个对象是否相等,并计算哈希码 - 默认的
toString()
:如果没有其他@ToString注解,也会生成toString()
方法,显示类的字段值 - 不可继承:如果可能,类会被隐式地声明为
final
,以防止子类继承并改变其行为
package com.demo;
import lombok.Value;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
@Value
private static class User{
private String name;
private Integer age;
}
}
@Accessors
它需要与其他注解(如@Setter
或@Data
)一起使用
package com.demo;
import lombok.Data;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;
/**
* Lombok的使用
*
* @author 16837
*/
@Slf4j
public class LombokDemo {
/**
* chain =true,表示设置值的时候,在给一个对象的多个属性赋值的时候不需要通过对象名称.setXxx()的形式,
* 而是直接使用setXxx()的形式,设置值的时候,可以不用换行
* setter和getter方法都是setXxx()和getXxx(),fluent = true,表示以属性名称作为方法名
* 如原来的setName(String name)方法名,变成name(String name),getName()方法名,变成name()
*/
@Data
@Accessors(chain = true, fluent = true)
private static class User {
private String name;
private Integer age;
}
public static void main(String[] args) {
User user = new User();
user.age(10).name("lisi");
System.out.println(user);
}
}
在IDEA
中可以查看到如下的对象属性的赋值方式
@Builder
@Builder
注解用于简化对象构建过程,它提供了链式方法来创建一个新的实例
package com.demo;
import lombok.Builder;
import lombok.Data;
import java.io.Serializable;
import java.util.List;
@Data
@Builder
public class User implements Serializable {
private String name;
private Integer age;
private List<String> hobbies;
}
package com.demo;
import java.util.List;
/**
* Lombok的使用
*
* @author 16837
*/
public class LombokDemo {
public static void main(String[] args) {
User user = User.builder()
.name("Alice")
.age(25)
.hobbies(List.of("Cooking", "Reading"))
.build();
System.out.println(user.toString());
}
}
程序运行输出结果
@SneakyThrows
注解@SneakyThrows
,作用是允许方法体中的语句抛出指定的检查异常,而不需要在方法签名中声明这些异常。它通过在编译期间使用字节码转换器自动运行来实现,避免了javac
对检查异常系统的强制性检查。该注解可以在方法或构造函数上使用,指定要"偷偷抛出"的异常类型。使用该注解时,会将方法体中的异常捕获并使用"魔法"技巧隐藏起来,实际上还是将异常抛出。这个技巧涉及到了字节码转换,在编译的最后阶段自动运行,不会对运行时产生依赖。
package com.demo;
import lombok.SneakyThrows;
/**
* Lombok的使用
*
* @author 16837
*/
public class LombokDemo {
@SneakyThrows
public static void shitHappens(){
Thread.sleep(1000);
}
public static void main(String[] args) {
shitHappens();
}
}
@Synchronized
就像在方法上放synchronized
关键字一样,只是会在私有的内部对象上同步
package com.demo;
import lombok.Cleanup;
import lombok.SneakyThrows;
import lombok.Synchronized;
import java.io.FileOutputStream;
/**
* Lombok的使用
*
* @author 16837
*/
public class LombokDemo {
@Synchronized
@SneakyThrows
public static void printInfo() {
String path = "1.txt";
@Cleanup FileOutputStream fileOutputStream = new FileOutputStream(path, true);
fileOutputStream.write("hello world".getBytes());
}
public static void main(String[] args) {
printInfo();
}
}
@Cleanup
无论发生什么情况,都可以通过调用其close方法来确保注释的变量声明得到清理。通过将局部变量声明之后的所有语句包装到作用域的末尾,将其封装到一个try块中,作为finally操作,该块将关闭资源
package com.demo;
import lombok.Cleanup;
import lombok.SneakyThrows;
import java.io.FileOutputStream;
/**
* Lombok的使用
*
* @author 16837
*/
public class LombokDemo {
@SneakyThrows
public static void printInfo() {
String path = "1.txt";
@Cleanup FileOutputStream fileOutputStream = new FileOutputStream(path, true);
fileOutputStream.write("hello world".getBytes());
}
public static void main(String[] args) {
printInfo();
}
}
程序运行之后,生成1.txt
文件,文件内容为
@FieldNameConstants
可以获取字段名称
package com.demo;
import lombok.Data;
import lombok.experimental.Accessors;
import lombok.experimental.FieldNameConstants;
import java.io.Serializable;
/**
* @FieldNameConstants 可以获取字段名称,使用mybatis指定更新的字段
*/
@Data
@Accessors(chain = true)
@FieldNameConstants
public class User implements Serializable {
private String name;
private Integer age;
}
package com.demo;
/**
* Lombok的使用
*
* @author 16837
*/
public class LombokDemo {
public static void main(String[] args) {
System.out.println(User.Fields.age);
System.out.println(User.Fields.name);
}
}
运行程序之后的输出结果如下