1、在maven项目的pom.xml文件中引入lombok依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
2、下载并安装jar
有2种方式在线安装或者本地安装,本来讲适用于所有IED开发工具的安装方式---本地安装
下载合适版本的lombok.jar
https://mvnrepository.com/artifact/org.projectlombok/lombok
或官网:https://www.projectlombok.org/download
找到在jar包所在目录使用doc命令提示窗口运行java命令:java -jar lombok-1.18.6.jar
D:\org\projectlombok\lombok\1.18.6>java -jar lombok-1.18.6.jar
运行成功后会弹出小辣椒标示的弹框,里面会自动扫描IDE工具也可自行勾选,点击"Install/Update" 按钮开始安装
安装后退出,重启IDE(eclipse或idea)开发工具
然后maven clean 一下maven项目重新编译看效果,之前使用的注解entity类在其他类总使用的get\set方法是否不在报错;
3、@Data 注解代码示例
import lombok.Data;
@Data
public class MyKeyPair {
private String priKey;
private String pubKey;
}
或者直接使用@Setter 、@Getter 注解
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class User {
private String userid;
private String username;
private String userpass;
}
也可以在某个属性上添加
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
public class User {
private String userid;
@Setter
@Getter
private String username;
private String userpass;
}
在其他类中就可以直接使用实体类属性的get \set方法了、这样就比之前传统的方式在代码上要 简洁很多,不用再单独对实体类属性写get\set方法了
4、@Slf4j 注解代码示例
传统的log日志打印写法:
private static final Logger logger = LoggerFactory.getLogger(LoggerTest.class);
logger.debug("debug");
logger.info("info");
logger.error("error");
使用注解写法,在类上添加@Slf4j注解,在方法中直接使用log:
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import lombok.extern.slf4j.XSlf4j;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@SpringBootTest
@Slf4j
public class LoggerTest {
//传统写法
// private final Logger logger = LoggerFactory.getLogger(LoggerTest.class);
@Test
public void test(){
log.debug("debug");
log.info("info");
log.error("error");
log.warn("warn");
}
}
5、常用注解详解
@Data注解:在JavaBean或类JavaBean中使用,这个注解包含范围最广,它包含getter、setter、NoArgsConstructor注解,即当使用当前注解时,会自动生成包含的所有方法;
@getter注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的getter方法;
@setter注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的setter方法;
@NoArgsConstructor注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的无参构造方法;
@AllArgsConstructor注解:在JavaBean或类JavaBean中使用,使用此注解会生成对应的有参构造方法;
@ToString注解:在JavaBean或类JavaBean中使用,使用此注解会自动重写对应的toStirng方法;
@EqualsAndHashCode注解:在JavaBean或类JavaBean中使用,使用此注解会自动重写对应的equals方法和hashCode方法;
@Slf4j:在需要打印日志的类中使用,当项目中使用了slf4j打印日志框架时使用该注解,会简化日志的打印流程,只需调用info方法即可;
@Log4j:在需要打印日志的类中使用,当项目中使用了log4j打印日志框架时使用该注解,会简化日志的打印流程,只需调用info方法即可;
在使用以上注解需要处理参数时,处理方法如下(以@ToString注解为例,其他注解同@ToString注解):
@ToString(exclude="column")
意义:排除column列所对应的元素,即在生成toString方法时不包含column参数;
@ToString(exclude={"column1","column2"})
意义:排除多个column列所对应的元素,其中间用英文状态下的逗号进行分割,即在生成toString方法时不包含多个column参数;
@ToString(of="column")
意义:只生成包含column列所对应的元素的参数的toString方法,即在生成toString方法时只包含column参数;;
@ToString(of={"column1","column2"})
意义:只生成包含多个column列所对应的元素的参数的toString方法,其中间用英文状态下的逗号进行分割,即在生成toString方法时只包含多个column参数;
(步骤5部分参考:https://blog.youkuaiyun.com/qq_36761831/article/details/86546970)