Lombok简化JavaBean开发

一.安装Lombok

1.为什么要导入Lombok依赖

导入Lombok依赖是为了在编译时根据不同的注解生成不同的代码，比如@Tostring注解在编译时会自动帮我们生成重写的toString方法。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

  

 

  
1
  
2
  
3
  
4
 

2.为什么要在idea中安装Lombok插件

• 在idea中安装Lombok插件是为了让我们使用Lombok注解时，不发生报错。
• 比如我们使用了@AllArgsConstructor注解，这个注解会在编译时自动帮我们生成有参构造器，因为@AllArgsConstructor注解是在编译时才帮助我们生成有参构造器，所以在编译前，代码中是没有有参构造器的，此时会发生报错。在idea中安装Lombok插件，就是为了提醒idea，让idea知道我们现在正在使用Lombok来简化JavaBean的开发。

二.Lombok中的相关注解

1. @Getter/@Setter

• 注解可以用在类和属性上
• @Getter/@Setter：在编译时自动生成get、set方法
• 默认生成的方法是public的，如果要修改方法修饰符可以设置AccessLevel的值，例如：@Getter(access = AccessLevel.PROTECTED)

2. @ToString

• 注解用在类上
• @ToString：在编译时自动为我们重写toString方法
• 默认情况下，它会按顺序（以逗号分隔）打印你的类名称以及每个字段。可以这样设置不包含哪些字段@ToString(exclude = “xx”) 或@ToString(exclude = {“xxx”,“xxx”})
• 如果继承的有父类的话，可以设置callSuper 让其调用父类的toString()方法，例如：@ToString(callSuper = true)

@ToString(callSuper = true,exclude = {"name","age"})

  

 

  
1
 

3. @AllArgsConstructor

• 注解用在类上
• @AllArgsConstructor：在编译时为我们自动生成 由所有参数构成的有参构造器。

4. @RequiredArgsConstructor

• 注解用在类上
• @RequiredArgsConstructor：在编译时为我们自动生成部分参数构造器
• 可能带参数也可能不带参数，如果带参数，这参数只能是以final修饰的未经初始化的字段，或者是以@NonNull注解的未经初始化的字段

5. @NoArgsConstructor

• 注解用在类上
• @NoArgsConstructor：在编译时为我们自动生成无参构造器
• 当类中有final字段没有被初始化时，编译器会报错，此时可用@NoArgsConstructor(force = true)，然后就会为没有初始化的final字段设置默认值 0 / false / null。
• 对于具有约束的字段（例如@NonNull字段），不会生成检查或分配，因此请注意，正确初始化这些字段之前，这些约束无效。

6. @EqualsAndHashCode

• 注解用在类上
• @EqualsAndHashCode：在编译时自动为我们重写hashCode和equals方法
• 默认情况下，它将使用所有非静态，非transient字段。
• 但可以通过在可选的exclude参数中来排除更多字段。

@EqualsAndHashCode(exclude = "name")

  

 

  
1
 

7. @NonNull

• 注解用在属性或构造器上
• @NonNull：会生成一个非空的声明，可用于校验参数，能帮助避免空指针。

8. @Data

• 注解用在类上
• @Data：会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

举例：

//Lombok
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@ToString
@EqualsAndHashCode
//@Data

public class Person {
	@NonNull
    public String name;
    public int age;
    public String gender;

    public Person( int age, String gender) {
        this.age = age;
        this.gender = gender;
    }
}


  

 

  
1
  
2
  
3
  
4
  
5
  
6
  
7
  
8
  
9
  
10
  
11
  
12
  
13
  
14
  
15
  
16
  
17
  
18
  
19
  
20
  
21
 

9. @Slf4j

• 注解用在类上
• @Slf4j：简化日志开发。
• 注入日志类，给注解所在类注入log属性，这就是我们的日志记录器，以后我们不用主动在控制台输出了，直接使用log.info()方法

举例：

//Lombok
@Slf4j

@Controller
@ResponseBody以字符串的方式写给浏览器，而不是跳转到某个页面
//@ResponseBody

//@RestController =  @Controller +  @ResponseBody
@RestController
public class HelloController {

    //自动注入属性
    @Qualifier(value = "human-com.ysw.boot.properties.Person")
    @Autowired
    Person person;

    @RequestMapping("/person")
    public Person getPerson(){
        log.info("into person");
        return person;
    }

    @RequestMapping("/hello")
    public String handle01(){
        log.info("into hello");
        return "Hello, SpringBoot 2.0 ! 加油！";
    }
}


  

 

  
1
  
2
  
3
  
4
  
5
  
6
  
7
  
8
  
9
  
10
  
11
  
12
  
13
  
14
  
15
  
16
  
17
  
18
  
19
  
20
  
21
  
22
  
23
  
24
  
25
  
26
  
27
  
28
  
29
 

三.Lombok的优缺点

优点：

• 能通过注解的形式自动生成构造器、getter/setter、equals、hashCode、toString等方法，提高了一定的开发效率
• 让代码变得简洁，不用过多的去关注相应的方法
• 属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点:

• 不支持多种参数构造器的重载
• 在编译器编译时通过操作AST（抽象语法树）改变字节码生成，变向的就是说它在改变Java语法。它不像Spring的依赖注入或者Mybatis的ORM一样是运行时的特性，而是编译时的特性。
• 虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

文章来源: blog.csdn.net，作者：Mr.Yushiwen，版权归原作者所有，如需转载，请联系作者。

原文链接：blog.csdn.net/MrYushiwen/article/details/112393592