Lombok 框架安装和简单使用

最新推荐文章于 2025-08-23 13:38:57 发布

胡千寻

最新推荐文章于 2025-08-23 13:38:57 发布

阅读量414

点赞数

分类专栏： lombok 文章标签：日志简化代码简化

lombok 专栏收录该内容

1 篇文章

订阅专栏

Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法，以及toString, hashCode等可能不会用到，但是某些时候仍然需要复写，以期方便使用的方法；

lombok 使用@slf4j简化日志对象的声明

在使用Lombok之后，将由其来自动帮你实现代码生成，注意，其是在运行过程中，帮你自动生成的。就是说，将极大减少你的代码总量。

Lombok的官方地址： https://projectlombok.org/

1，集成lombok插件到开发工具；
描述：
如果开发工具未安装lombok的插件，将检查不到使用的对象；
eclipse示例：
转载：https://my.oschina.net/u/3771868/blog/1837243
ombok官网：https://projectlombok.org/
jar包下载路径：https://projectlombok.org/download
lombok features：https://projectlombok.org/features/all

方式一（推荐）：
1.下载lombok.jar包
2.将lombok.jar包复制到myeclipse.ini/eclipse.ini所在文件目录
在这里插入图片描述
3.打开myeclipse.ini/eclipse.ini，在最后添加以下代码并保存：
　-Xbootclasspath/a:lombok.jar
-javaagent:lombok.jar
注意：
-Xbootclasspath/a:lombok.jar 这个可写可不写
-javaagent:lombok.jar 这个必须写

4.重启myeclipse/eclipse.
5.project==>clean 清理项目或者更新项目
方式二：
1.下载lombok.jar包
2、运行Lombok.jar: java -jar D:\001_software\work\Java\libs\lombok.jar
数秒后将弹出一框，以确认eclipse的安装路径
3、确认完eclipse的安装路径后，点击install/update按钮，即可安装完成
4、安装完成之后，请确认eclipse安装路径下是否多了一个lombok.jar包，并且其
配置文件eclipse.ini中是否添加了如下内容:
-javaagent:lombok.jar
-Xbootclasspath/a:lombok.jar
如果上面的答案均为true，那么恭喜你已经安装成功，否则将缺少的部分添加到相应的位置即可
5、重启eclipse或myeclipse

方式三：
MAVEN项目加入lombok，版本选择你在eclipse中集成的版本。

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

2，lombok使用：
转载：https://www.jb51.net/article/123862.htm
主要是基于标注来进行信息的封装和使用：
@NonNull：标识对象是否为空，为空则抛出异常
@Getter: 自动生成Getter方法
@Setter: 自动生成Setter
@ToString：覆盖tostring方法
@EqualsAndHashCode: 覆盖equal和hashCode方法
@Data: @Getter/@Setter, @ToString, @EqualAndHashCode等组合
@Slf4j: 默认使用slf4j的日志对象
4. 使用示例：
示例Getter/Setter方法以及日志使用：

import lombok.Data; 
import lombok.extern.slf4j.Slf4j; 
  
@Slf4j
@Data
public class TestBean { 
 private String name; 
 private int age; 
}

测试用例：

import org.junit.Test; 
import org.junit.runner.RunWith; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.boot.test.context.SpringBootTest; 
import org.springframework.test.context.junit4.SpringRunner; 
  
import lombok.extern.slf4j.Slf4j; 
  
@RunWith(SpringRunner.class) 
@SpringBootTest
@Slf4j
public class TestEntityBean { 
  
 TestBean bean = new TestBean(); 
   
 @Autowired
 private MyCase mycase; 
   
   
 //@Test 
 public void test() { 
  bean.setAge(123); 
  bean.setName("zhangsan"); 
    
  log.info(bean.toString()); 
 } 
}

用例运行结果

. ____   _   __ _ _ 
 /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ 
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ 
 \\/ ___)| |_)| | | | | || (_| | ) ) ) ) 
 ' |____| .__|_| |_|_| |_\__, | / / / / 
 =========|_|==============|___/=/_/_/_/ 
 :: Spring Boot ::  (v1.4.1.RELEASE) 
  
2016-10-24 11:49:19.521 INFO 700 --- [   main] org.cuckoo.report.brain.TestEntityBean : Starting TestEntityBean on 08-201412015324 with PID 700 (started by junfengchen in D:\Dev\workspace\JSPDemo) 
2016-10-24 11:49:19.523 INFO 700 --- [   main] org.cuckoo.report.brain.TestEntityBean : No active profile set, falling back to default profiles: default
2016-10-24 11:49:19.647 INFO 700 --- [   main] o.s.w.c.s.GenericWebApplicationContext : Refreshing org.springframework.web.context.support.GenericWebApplicationContext@4f80542f: startup date [Mon Oct 24 11:49:19 CST 2016]; root of context hierarchy 
2016-10-24 11:49:22.191 INFO 700 --- [   main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.web.context.support.GenericWebApplicationContext@4f80542f: startup date [Mon Oct 24 11:49:19 CST 2016]; root of context hierarchy 
2016-10-24 11:49:22.290 INFO 700 --- [   main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/foo]}" onto public java.lang.String org.cuckoo.report.brain.WelcomeController.foo(java.util.Map<java.lang.String, java.lang.Object>) 
2016-10-24 11:49:22.293 INFO 700 --- [   main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/],methods=[GET]}" onto public java.lang.String org.cuckoo.report.brain.WelcomeController.welcome(java.util.Map<java.lang.String, java.lang.Object>) 
2016-10-24 11:49:22.295 INFO 700 --- [   main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest) 
2016-10-24 11:49:22.296 INFO 700 --- [   main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) 
2016-10-24 11:49:22.351 INFO 700 --- [   main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2016-10-24 11:49:22.351 INFO 700 --- [   main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2016-10-24 11:49:22.409 INFO 700 --- [   main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler] 
2016-10-24 11:49:22.642 INFO 700 --- [   main] org.cuckoo.report.brain.TestEntityBean : Started TestEntityBean in 3.868 seconds (JVM running for 4.854) 
2016-10-24 11:49:22.676 INFO 700 --- [   main] org.cuckoo.report.brain.TestEntityBean : TestBean(name=zhangsan, age=123) 
2016-10-24 11:49:22.691 INFO 700 --- [  Thread-2] o.s.w.c.s.GenericWebApplicationContext : Closing org.springframework.web.context.support.GenericWebApplicationContext@4f80542f: startup date [Mon Oct 24 11:49:19 CST 2016]; root of context hierarchy

大家可以注意到@Slf4j替代掉了冗余的logger声明语句， @Data不必在使用Getter/Setter方法，其中toString默认反射对象中的所有属性，非常的好用。