SpringBoot [ 4.使用Lombok] - 目录
文章目录
1.概述
我前面得几篇博客频繁得使用到了Lombok,这里我就讲一下,我在公司得工作过程当中,我最常用得一些Lombok得注解得用法。
Lombok它是一款使用注解,用来精简代码,提高编程效率得Java工具,
至于它是怎么精简得,以及它得一些特性,下面得内容我会介绍。
2.使用
2.1.编译器集成Lombok插件
Java编译器,idea和eclipse都可以集成Lombok插件,本人使用得是idea,这里就简单介绍一下idea得集成。
打开idea得setting配置,在Plugins中搜索Lombok,点击安装,然后重启编译器即可使用。
2.2.pom引入依赖
spring-boot-dependencies当中已经有了Lombok得版本管理,这里我们直接引入就好了。
<!-- Lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
<!-- 依赖统一管理 -->
<dependencyManagement>
<dependencies>
<!-- Spring Boot -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring.boot.version}</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
3.常用注解
在工作当中,我最常用得就是在,entity,dto,vo这些类上频繁得使用到Lombok得注解; 这些注解得作用其实就是,使用之后不需要编写对应得Java代码,比如说我使用@Getter注解之后,就不需要编写get方法;
不需要编写代码,那项目怎么运行呢,是这样的,在项目进行打包编译得时候它会在.class文件中自动生成对应得代码,只不过在我们项目源码中没有对应得编码。
3.1.类注解
3.1.1.@Getter
在类打上@Getter注解,不需要生成Get方法得代码,其他地方就可直接使用Get方法;
package com.mantou.boot.dto;
import lombok.*;
/**
* Lombok测试类
* @author mantou
*/
@Getter
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
/**
* Lombok测试接口
* @author mantou
*/
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {
/**
* 获取Lombok实例
* @return
*/
@GetMapping(value = "/getLombokInstance")
public Result getLombokInstance() {
LombokDemoDTO lombokDemoDTO = new LombokDemoDTO();
String content = lombokDemoDTO.getContent();
return Result.success();
}
}
3.1.2.@Setter
在类打上@Setter注解,不需要生成Set方法得代码,其他地方就可直接使用Set方法;
package com.mantou.boot.dto;
import lombok.*;
/**
* Lombok测试类
* @author mantou
*/
@Getter
@Setter
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
/**
* Lombok测试接口
* @author mantou
*/
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {
/**
* 获取Lombok实例
* @return
*/
@GetMapping(value = "/getLombokInstance")
public Result getLombokInstance() {
LombokDemoDTO lombokDemoDTO = new LombokDemoDTO();
lombokDemoDTO.setContent("内容");
String content = lombokDemoDTO.getContent();
return Result.success();
}
}
3.1.3.@ToString
在类打上@ToString注解,会重写类得toString方法
package com.mantou.boot.dto;
import lombok.*;
/**
* Lombok测试类
* @author mantou
*/
@Getter
@Setter
@ToString
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
3.1.5.@EqualsAndHashCode
在类打上@EqualsAndHashCode注解,会重写类得equals方法和hashCode方法
import lombok.*;
/**
* Lombok测试类
* @author mantou
*/
@Getter
@Setter
@ToString
@EqualsAndHashCode
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
到这里为止,我们可以看一下项目编译过后的.class文件
很明显,它生成了get方法,set方法,重写了toString方法,hashCode方法和equals方法.
3.1.4.@Data
这个@Data是我最常用的注解之一,因为具备@Setter,@Getter,@ToString,@EqualsAndHashCode的功能。
这个时候,我们把上面的那四个注解去掉,打上@Data注解
import lombok.*;
/**
* Lombok测试类
* @author mantou
*/
@Data
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
打上注解以后,把.class文件clean一下,重写编译,再看.class文件
我们可以发现,生成的编码和上面那四个注解生成的编码是一样的.
3.1.5.@RequiredArgsConstructor
这个注解我比较喜欢用,类打上这个注解后,会生成一个静态方法,该方法会返回一个new的对象,这个方法名是由我们自定义的.
package com.mantou.boot.dto;
import lombok.*;
/**
* Lombok测试类
* @author mantou
*/
@Data
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
/**
* Lombok测试接口
* @author mantou
*/
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {
/**
* 获取Lombok实例
* @return
*/
@GetMapping(value = "/getLombokInstance")
public Result getLombokInstance() {
LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO();
lombokDemoDTO.setContent("内容");
String content = lombokDemoDTO.getContent();
return Result.success(lombokDemoDTO.toString());
}
}
这个时候我们再来看一下.class文件,生成了一个静态的方法,返回一个new的对象
3.1.6.@AllArgsConstructor
在类打上@AllArgsConstructor注解,会生成一个有所有参数的构造方法
/**
* Lombok测试类
* @author mantou
*/
@Data
@AllArgsConstructor
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
看下.class文件
3.1.7.@Accessors
这个注解其实就是使对象支持链式的set方法
package com.mantou.boot.dto;
import lombok.*;
import lombok.experimental.Accessors;
/**
* Lombok测试类
* @author mantou
*/
@Data
@AllArgsConstructor
@Accessors(chain = true)
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {
/**
* 标题
*/
private String title;
/**
* 内容
*/
private String content;
}
使用
/**
* Lombok测试接口
* @author mantou
*/
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {
/**
* 获取Lombok实例
* @return
*/
@GetMapping(value = "/getLombokInstance")
public Result getLombokInstance() {
LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO()
.setContent("内容").setTitle("标题");
String content = lombokDemoDTO.getContent();
return Result.success(lombokDemoDTO.toString());
}
}
我们看一下.class文件,其实就是在set方法加了一个返回值
3.1.8.@Slf4j
这个是一个提供日志对象(log)的注解,我项目中日志使用的是slf4j + logback,我这里就使用@Slf4j注解,如果日志使用的是log4j,那就使用@Log4j注解;
/**
* Lombok测试接口
* @author mantou
*/
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {
/**
* 获取Lombok实例
* @return
*/
@GetMapping(value = "/getLombokInstance")
public Result getLombokInstance() {
LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO()
.setContent("内容").setTitle("标题");
String content = lombokDemoDTO.getContent();
log.info("content : {}", content);
return Result.success(lombokDemoDTO.toString());
}
再看一下.class文件,生成了一个日志对象
我在实际的开发当中,最常用的Lombok注解就这些了.