lombok使用

2018-06-16  本文已影响0人  tommyhxh

作用

Lombok是一种Java™实用工具,可用来帮助开发人员消除Java的冗长代码,尤其是对于简单的Java对象(POJO)。它通过注释实现这一目的。通过在开发环境中实现Lombok,开发人员可以节省构建诸如hashCode()和equals()这样的方法以及以往用来分类各种accessor和mutator的大量时间。

注解说明

@val
用在局部变量前面,相当于将变量声明为final
@NonNull
给方法参数增加这个注解会自动在方法内对该参数进行是否为空的校验,为空抛出NPE
@Cleanup
自动管理资源,用在局部变量之前,在当前变量范围内即将执行完毕退出之前会自动清理资源,自动生成try-finally这样的代码来关闭流
@Getter/Setter
用在属性上,再也不用自己手写setter和getter方法了,还可以指定访问范围
@ToString
用在类上,可以自动覆写toString方法,当然还可以加其他参数,例如@ToString(exclude=”id”)排除id属性,或者@ToString(callSuper=true, includeFieldNames=true)调用父类的toString方法,包含所有属性
@EqualsAndHashCode
用在类上,自动生成equals方法和hashCode方法,callSuper 是否调用父类,exclude排除参数;of指定参数。
@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
用在类上,自动生成无参构造和使用所有参数的构造函数以及把所有@NonNull属性作为参数的构造函数,如果指定staticName = “of”参数,同时还会生成一个返回类对象的静态工厂方法,比使用构造函数方便很多
@Data
注解在类上,相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解,对于POJO类十分有用
@Value
用在类上,是@Data的不可变形式,相当于为属性添加final声明,只提供getter方法,而不提供setter方法

@Builder
用在类、构造器、方法上,为你提供复杂的builder APIs
@SneakyThrows
自动抛受检异常,而无需显式在方法上使用throws语句*
@Synchronized
用在方法上,将方法声明为同步的,并自动加锁,而锁对象是一个私有的属性$lock或$LOCK,而java中的synchronized关键字锁对象是this,锁在this或者自己的类对象上存在副作用,就是你不能阻止非受控代码去锁this或者类对象,这可能会导致竞争条件或者其它线程错误
@Getter(lazy=true)
可以替代经典的Double Check Lock样板代码
@Log
根据不同的注解生成不同类型的log对象,但是实例名称都是log,有六种可选实现类
* @CommonsLog Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
* @Log Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName());
* @Log4j Creates log = org.apache.log4j.Logger.getLogger(LogExample.class);
* @Log4j2 Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
* @Slf4j Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
* @XSlf4j Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

部分实例

1.value

@Value
public class LombokDemo {
    @NonNull
    private int id;
    @NonNull
    private String shap;
    private int age;
    //相当于
    private final int id;
    public int getId() {
        return this.id;
    }
    ...
}

2.构造函数

@NoArgsConstructor
@RequiredArgsConstructor(staticName = "of")
@AllArgsConstructor
public class LombokDemo {
    @NonNull
    private int id;
    @NonNull
    private String shap;
    private int age;
    public static void main(String[] args) {
        new LombokDemo(1, "circle");
        //使用静态工厂方法
        LombokDemo.of(2, "circle");
        //无参构造
        new LombokDemo();
        //包含所有参数
        new LombokDemo(1, "circle", 2);
    }
}

3.CleanUp

public static void main(String[] args) {
    try {
        @Cleanup InputStream inputStream = new FileInputStream(args[0]);
    } catch (FileNotFoundException e) {
        e.printStackTrace();
    }
    //=>相当于
    InputStream inputStream = null;
    try {
        inputStream = new FileInputStream(args[0]);
    } catch (FileNotFoundException e) {
        e.printStackTrace();
    } finally {
        if (inputStream != null) {
            try {
                inputStream.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

4.val

public static void main(String[] args) {
    val sets = new HashSet<String>();
    val lists = new ArrayList<String>();
    val maps = new HashMap<String, String>();
    //=>相当于如下
    final Set<String> sets2 = new HashSet<>();
    final List<String> lists2 = new ArrayList<>();
    final Map<String, String> maps2 = new HashMap<>();
}
上一篇 下一篇

猜你喜欢

热点阅读