转载

Lombok安装及Spring Boot集成Lombok

Lombok有什么用

在我们实体 Bean 中有大量的 Getter/Setter 方法以及 toString , hashCode 等可能不会用到，但是某些时候仍然需要复写；在使用 Lombok 之后，将由其来自动帮你实现代码生成。注意，其是在 编译源码 过程中，帮你自动生成的。就是说，将极大减少你的代码总量。

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

使用Lombok时需要注意的点

  • 在类需要序列化、反序列化时或者需要详细控制字段时，应该谨慎考虑是否要使用Lombok，因为在这种情况下容易出问题。例如：Jackson、Json序列化
  • 使用Lombok虽然能够省去手动创建 setter 和 getter 方法等繁琐事情，但是却降低了源代码文件的可读性和完整性，减低了阅读源代码的舒适度
  • 使用 @Slf4j 还是 @Log4j 注解，需要根据实际项目中使用的日志框架来选择。
  • Lombok并非处处适用，我们需要选择适合的地方使用Lombok，例如pojo是一个好地方，因为pojo很单纯

Lombok的安装

eclipse安装Lombok步骤：

  1. 下载最新的 lombok.jar 包，下载地址： https://projectlombok.org/download.html
  2. 进入 cmd 窗口，切到 Lombok 下载的目录，运行命令： java -jar lombok.jar ，会出现如下界面：

    Lombok安装及Spring Boot集成Lombok

    已经默认选好了eclipse安装目录（这个可能是因为我只有一个盘，如果没有默认选择，可以自己点击下方 Specify location... 按钮选择eclipse安装目录），点击图中红色箭头指向的按钮，即可完成安装。成功界面如下：

    Lombok安装及Spring Boot集成Lombok

  3. eclipse安装目录下的 eclipse.ini 文件末尾已经加了一行内容（这个路径因人而异，和eclipse安装目录有关），如下：
    Lombok安装及Spring Boot集成Lombok

    而且安装目录下也多了一个 lombok.jar

spring boot集成Lombok

  1. 先去 http://start.spring.io/ 在线生成一个spring boot项目脚手架，导入eclipse。

  2. 在 pom.xml 里添加 Lombok 依赖： 

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

  3. 在 src/main/java/com/example/springbootlombok/entity 下新建一个 student.java 的Java bean： 

    package com.example.springbootlombok.entity;

import lombok.Data;
        
@Data
public class Student {
    private String name;
    private int age;
}

  4. 在 src/test/java/com/example/springbootlombok 下新建一个 TestEntity.java 的测试类： 

    package com.example.springbootlombok;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
    
import com.example.springbootlombok.entity.Student;
    
import lombok.extern.slf4j.Slf4j;
    
@RunWith(SpringRunner.class)
@SpringBootTest
@Slf4j
public class TestEntity {
        
    Student student = new Student();
        
    @Test
    public void test() {
        student.setName("张三");
        student.setAge(12);
        log.info("测试结果:" + student.toString());
    }
}
  5. 执行JUnit测试，成功的话，日志里会有打印 测试结果:Student(name=张三, age=12) ，至此，spring boot已经成功集成Lombok了。

Lombok常用注解

@NonNull

这个注解可以 用在成员方法或者构造方法的参数前面 ，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常，举个例子：

编译前的代码：

//成员方法参数加上@NonNull注解
public String getName(@NonNull Person p) {
    return p.getName();
}

编译后的代码：

public String getName(@NonNull Person p) {
    if (p == null) {
        throw new NullPointerException("person");
    }
    return p.getName();
}

@Cleanup

这个注解 用在变量前面 ，可以保证此变量代表的资源会被自动关闭，默认是调用资源的 close() 方法，如果该资源有其它关闭方法，可使用 @Cleanup("methodName") 来指定要调用的方法，就用输入输出流来举个例子：

编译前的代码：

public static void main(String[] args) throws IOException {
    @Cleanup InputStream in = new FileInputStream(args[0]);
    @Cleanup OutputStream out = new FileOutputStream(args[1]);
    byte[] b = new byte[1024];
    while (true) {
        int r = in.read(b);
        if (r == -1) break;
        out.write(b, 0, r);
    }
 }

编译后的代码：

public static void main(String[] args) throws IOException {
    InputStream in = new FileInputStream(args[0]);
    try {
        OutputStream out = new FileOutputStream(args[1]);
        try {
            byte[] b = new byte[10000];
            while (true) {
                int r = in.read(b);
                if (r == -1) break;
                out.write(b, 0, r);
            }
        } finally {
            if (out != null) {
                out.close();
            }
        }
    } finally {
        if (in != null) {
            in.close();
        }
    }
}

@Getter/@Setter

这一对注解从名字上就很好理解， 用在成员变量前面 ，相当于为成员变量生成对应的get和set方法，同时还可以为生成的方法指定访问修饰符，当然，默认为public，直接来看下面的简单的例子：

编译前的代码：

public class Programmer {
    @Getter
    @Setter
    private String name;

    @Setter(AccessLevel.PROTECTED)
    private int age;

    @Getter(AccessLevel.PUBLIC)
    private String language;
}

编译后的代码：

public class Programmer {
    private String name;
    private int age;
    private String language;

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    protected void setAge(int age) {
        this.age = age;
    }

    public String getLanguage() {
        return language;
    }
}

这两个注解还可以直接 用在类上 ，可以为此类里的所有 非静态成员变量 生成对应的get和set方法。

@Getter(lazy=true)

如果Bean的一个字段的初始化是代价比较高的操作，比如加载大量的数据；同时这个字段并不是必定使用的。那么使用懒加载机制，可以保证节省资源。

懒加载机制，是对象初始化时，该字段并不会真正的初始化，而是第一次访问该字段时才进行初始化字段的操作。

@ToString/@EqualsAndHashCode

这两个注解也比较好理解，就是生成 toString ， equals 和 hashcode 方法，同时后者还会生成一个 canEqual 方法，用于判断某个对象是否是当前类的实例，生成方法时只会使用类中的 非静态和非transient成员变量 ，这些都比较好理解，就不举例子了。

当然，这两个注解也可以添加限制条件，例如用 @ToString(exclude={"param1","param2"}) 来 排除 param1和param2两个成员变量，或者用 @ToString(of={"param1","param2"}) 来 指定 使用param1和param2两个成员变量， @EqualsAndHashCode 注解也有同样的用法。

@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor

这三个注解都是 用在类上 的，第一个和第三个都很好理解，就是为该类产生无参的构造方法和包含所有参数的构造方法，第二个注解则使用类中所有 带有@NonNull注解的或者带有final修饰的成员变量 生成对应的构造方法。当然，和前面几个注解一样， 成员变量都是非静态的 ，另外，如果类中 含有final修饰的成员变量，是无法使用@NoArgsConstructor注解 的。

三个注解都可以 指定 生成的构造方法的 访问权限 ，同时，第二个注解还可以用 @RequiredArgsConstructor(staticName="methodName") 的形式生成一个指定名称的静态方法，返回一个调用相应的构造方法产生的对象，下面来看一个生动鲜活的例子：

编译前的代码：

@RequiredArgsConstructor(staticName = "sunsfan")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@NoArgsConstructor
public class Shape {
    private int x;
    @NonNull
    private double y;
    @NonNull
    private String name;
}

编译后的代码：

public class Shape {
    private int x;
    private double y;
    private String name;

    public Shape() {
    }

    protected Shape(int x, double y, String name) {
        this.x = x;
        this.y = y;
        this.name = name;
    }

    public Shape(double y, String name) {
        this.y = y;
        this.name = name;
    }

    public static Shape sunsfan(double y, String name) {
        return new Shape(y, name);
    }
}

@Data/@Value

@Data 注解综合了 @Getter/@Setter ， @ToString ， @EqualsAndHashCode 和 @RequiredArgsConstructor 注解，其中 @RequiredArgsConstructor 使用了类中的带有 @NonNull 注解的或者final修饰的成员变量，它可以使用 @Data(staticConstructor="methodName") 来生成一个静态方法，返回一个调用相应的构造方法产生的对象。

@Value 注解和 @Data 类似， 区别 在于它会 把所有成员变量默认定义为 private final 修饰，并且不会生成set方法 。

@SneakyThrows

这个注解 用在方法上 ，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常，很简单的注解，直接看个例子：

编译前的代码：

public class SneakyThrows implements Runnable {
    @SneakyThrows(UnsupportedEncodingException.class)
    public String utf8ToString(byte[] bytes) {
        return new String(bytes, "UTF-8");
    }

    @SneakyThrows
    public void run() {
        throw new Throwable();
    }
}

编译后的代码：

public class SneakyThrows implements Runnable {
    @SneakyThrows(UnsupportedEncodingException.class)
    public String utf8ToString(byte[] bytes) {
        try {
            return new String(bytes, "UTF-8");
        } catch(UnsupportedEncodingException uee) {
            throw Lombok.sneakyThrow(uee);
        }
    }

    @SneakyThrows
    public void run() {
        try {
            throw new Throwable();
        } catch(Throwable t) {
            throw Lombok.sneakyThrow(t);
        }
    }
}

@Synchronized

这个注解 用在类方法或者实例方法上 ，效果和 synchronized 关键字相同， 区别 在于 锁对象不同 ，对于类方法和实例方法， synchronized 关键字的锁对象分别是 类的class对象 和 this对象 ，而 @Synchronized 的锁对象分别是 私有静态final对象LOCK 和 私有final对象lock ，当然，也可以 自己指定锁对象 ，例子也很简单，往下看：

编译前的代码：

public class Synchronized {
    private final Object readLock = new Object();

    @Synchronized
    public static void hello() {
        System.out.println("world");
    }

    @Synchronized
    public int answerToLife() {
        return 42;
    }

    @Synchronized("readLock")
    public void foo() {
        System.out.println("bar");
    }
}

编译后的代码：

public class Synchronized {
    private static final Object $LOCK = new Object[0];
    private final Object $lock = new Object[0];
    private final Object readLock = new Object();

    public static void hello() {
        synchronized($LOCK) {
            System.out.println("world");
        }
    }

    public int answerToLife() {
        synchronized($lock) {
            return 42;
        }
    }

    public void foo() {
        synchronized(readLock) {
            System.out.println("bar");
        }
    }
}

@Log

这个注解 用在类上 ，可以省去从日志工厂生成日志对象这一步，直接进行日志记录，具体注解根据日志工具的不同而不同，同时，可以在注解中使用 topic 来指定生成log对象时的类名。不同的日志注解总结如下(上面是注解，下面是编译后的代码)： 

@CommonsLog
==> private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);

@JBossLog
==> private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);

@Log
==> private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

@Log4j
==> private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);

@Log4j2
==> private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);

@Slf4j
==> private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);

@XSlf4j
==> private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

参考资料

  • Spring Boot下的lombok安装以及使用简介
  • lombok注解介绍
原文  https://segmentfault.com/a/1190000018528777
正文到此结束
所属分类： Spring

热门推荐

相关文章

阿里云首购8折
说给你听

本文目录
随机标签
书籍教程
springboot-demo Java入门教程 bootstrap3 CSS Apache基础教程 php ionic 教程 Python mysql教程 eclipse Ubuntu VPS系统配置 AngularJS 教程 MongoDB教程 Struts2教程 Redis教程 Spring教程 Git教程 Jenkins进阶系列 openfire参考指南 Java设计模式 HBase教程 Maven教程 hibernate教程 Docker 教程 memcached教程 Quartz指南 Hive教程 Ant教程 ANTLR教程 SpringCloud java实例教程 springcloud-demo XStream教程 Hazelcast教程 Elastic-Job-Lite 深入浅出MyBatis SVN教程 ibaties教程 rabittmq教程 solr教程 Hadoop教程 WebService CXF学习 JPA教程 ActiveMQ中文指南 java-demo Java内存模型 dubbo教程 python3-demo Linux入门视频教程
近期评论
  1. 1 Spring Cloud Consul实现选举机制
  2. 2 Spring Boot集成ShedLock实现分布式定时任务
  3. 3 利用oss进行数据库和网站图片备份
  4. 4 Spring Cloud Stream实现数据流处理
  5. 5 Python3访问MySQL数据库快速入门Demo
  6. 6 Github开源项目作者可以免费申请 JetBrains 全家桶
  7. 7 Spring Cloud Vault快速入门Demo
  8. 8 Spring Cloud Gateway快速入门Demo
  9. 9 Spring Cloud Contract快速入门Demo
  10. 10 Spring Cloud Consul快速入门Demo
网站信息
  • 文章总数：82,714 篇
  • 文件总数：284,287 个
  • 标签总数：2,393 个
  • 分类总数：85 个
  • 留言数量：2,560 条
  • 在线人数：686 人
  • 运行天数：4,409天
  • 最后更新：2024年11月22日03点
Loading...

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

[HBLOG]公众号 HBLOG HBLOG