代码洁癖的春天！Java效率工具之Lombok

还在编写无聊枯燥又难以维护的POJO吗？洁癖者的春天在哪里？请看Lombok！

创新互联专注于怒江州网站建设服务及定制，我们拥有丰富的企业做网站经验。 热诚为您提供怒江州营销型网站建设，怒江州网站制作、怒江州网页设计、怒江州网站官网定制、重庆小程序开发服务，打造怒江州网络公司原创品牌,更为您提供怒江州网站排名全网营销落地服务。

在过往的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。

首先说明一下：任何技术的出现都是为了解决某一类问题的，如果在此基础上再建立奇技淫巧，不如回归Java本身。应该保持合理使用而不滥用。

Lombok的使用非常简单，下面我们一起来看下：

1）引入相应的maven包：

 
 
 
 
    
  
  
  
  
  1.  
    2. 
  
  
  
  
  2.   org.projectlombok 
    3. 
  
  
  
  
  3.   lombok 
    4. 
  
  
  
  
  4.   1.16.18 
    5. 
  
  
  
  
  5.   provided 
    6. 
  
  
  
  
  6.

Lombok的scope=provided，说明它只在编译阶段生效，不需要打入包中。事实正是如此，Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。

2）添加IDE工具对Lombok的支持：

IDEA中引入Lombok支持如下：

  •  点击File-- Settings设置界面，安装Lombok插件： 

  • 点击File-- Settings设置界面，开启Annocation Processors：

开启该项是为了让Lombok注解在编译阶段起到作用。

Eclipse的Lombok插件安装可以自行百度，也比较简单，值得一提的是，由于Eclipse内置的编译器不是Oracle javac，而是eclipse自己实现的Eclipse Compiler for Java (ECJ).要让ECJ支持Lombok，需要在eclipse.ini配置文件中添加如下两项内容：

-Xbootclasspath/a:[lombok.jar所在路径]

-javaagent:[lombok.jar所在路径]

3）Lombok实现原理：

自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中，它产生作用的具体流程如下：

  •  javac对源代码进行分析，生成一棵抽象语法树(AST)
  •  javac编译过程中调用实现了JSR 269的Lombok程序
  •  此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点
  •  javac使用修改后的抽象语法树(AST)生成字节码文件

4) Lombok注解的使用：

POJO类常用注解：

@Getter/@Setter: 作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。

 
 
 
 
    
  
  
  
  
  1. package com.trace; 
    2. 
  
  
  
  
  2. import lombok.AccessLevel; 
    3. 
  
  
  
  
  3. import lombok.Getter; 
    4. 
  
  
  
  
  4. import lombok.Setter; 
    5. 
  
  
  
  
  5. /** 
    6. 
  
  
  
  
  6.  * Created by Trace on 2018/5/19.
     
    7. 
  
  
  
  
  7.  * DESC: 测试类 
    8. 
  
  
  
  
  8.  */ 
    9. 
  
  
  
  
  9. @SuppressWarnings("unused") 
    10. 
  
  
  
  
  10. public class TestClass { 
    11. 
  
  
  
  
  11.     public static void main(String[] args) { 
    12. 
  
  
  
  
  12.     } 
    13. 
  
  
  
  
  13.     @Getter(value = AccessLevel.PUBLIC) 
    14. 
  
  
  
  
  14.     @Setter(value = AccessLevel.PUBLIC) 
    15. 
  
  
  
  
  15.     public static class Person { 
    16. 
  
  
  
  
  16.         private String name; 
    17. 
  
  
  
  
  17.         private int age; 
    18. 
  
  
  
  
  18.         private boolean friendly; 
    19. 
  
  
  
  
  19.     } 
    20. 
  
  
  
  
  20.     public static class Animal { 
    21. 
  
  
  
  
  21.         private String name; 
    22. 
  
  
  
  
  22.         private int age; 
    23. 
  
  
  
  
  23.         @Getter @Setter private boolean funny; 
    24. 
  
  
  
  
  24.     } 
    25. 
  
  
  
  
  25.  }
    26.

在Structure视图中，可以看到已经生成了getter/setter等方法：

编译后的代码如下：[这也是传统Java编程需要编写的样板代码]

 
 
 
 
    
  
  
  
  
  1. // 
    2. 
  
  
  
  
  2. // Source code recreated from a .class file by IntelliJ IDEA 
    3. 
  
  
  
  
  3. // (powered by Fernflower decompiler) 
    4. 
  
  
  
  
  4. // 
    5. 
  
  
  
  
  5. package com.trace; 
    6. 
  
  
  
  
  6. public class TestClass { 
    7. 
  
  
  
  
  7.     public TestClass() { 
    8. 
  
  
  
  
  8.     } 
    9. 
  
  
  
  
  9.     public static void main(String[] args) { 
    10. 
  
  
  
  
  10.     } 
    11. 
  
  
  
  
  11.     public static class Animal { 
    12. 
  
  
  
  
  12.         private String name; 
    13. 
  
  
  
  
  13.         private int age; 
    14. 
  
  
  
  
  14.         private boolean funny; 
    15. 
  
  
  
  
  15.         public Animal() { 
    16. 
  
  
  
  
  16.         } 
    17. 
  
  
  
  
  17.         public boolean isFunny() { 
    18. 
  
  
  
  
  18.             return this.funny; 
    19. 
  
  
  
  
  19.         } 
    20. 
  
  
  
  
  20.         public void setFunny(boolean funny) { 
    21. 
  
  
  
  
  21.             this.funny = funny; 
    22. 
  
  
  
  
  22.         } 
    23. 
  
  
  
  
  23.     } 
    24. 
  
  
  
  
  24.     public static class Person { 
    25. 
  
  
  
  
  25.         private String name; 
    26. 
  
  
  
  
  26.         private int age; 
    27. 
  
  
  
  
  27.         private boolean friendly; 
    28. 
  
  
  
  
  28.         public Person() { 
    29. 
  
  
  
  
  29.         } 
    30. 
  
  
  
  
  30.         public String getName() { 
    31. 
  
  
  
  
  31.             return this.name; 
    32. 
  
  
  
  
  32.         } 
    33. 
  
  
  
  
  33.         public int getAge() { 
    34. 
  
  
  
  
  34.             return this.age; 
    35. 
  
  
  
  
  35.         } 
    36. 
  
  
  
  
  36.         public boolean isFriendly() { 
    37. 
  
  
  
  
  37.             return this.friendly; 
    38. 
  
  
  
  
  38.         } 
    39. 
  
  
  
  
  39.         public void setName(String name) { 
    40. 
  
  
  
  
  40.             this.name = name; 
    41. 
  
  
  
  
  41.         } 
    42. 
  
  
  
  
  42.         public void setAge(int age) { 
    43. 
  
  
  
  
  43.             this.age = age; 
    44. 
  
  
  
  
  44.         } 
    45. 
  
  
  
  
  45.         public void setFriendly(boolean friendly) { 
    46. 
  
  
  
  
  46.             this.friendly = friendly; 
    47. 
  
  
  
  
  47.         } 
    48. 
  
  
  
  
  48.     } 
    49. 
  
  
  
  
  49. }
    50.

@ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。

@EqualsAndHashCode：作用于类，覆盖默认的equals和hashCode

@NonNull：主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常。

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：作用于类上，用于生成构造函数。有staticName、access等属性。

staticName属性一旦设定，将采用静态方法的方式生成实例，access属性可以限定访问权限。

@NoArgsConstructor：生成无参构造器；

@RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；

@AllArgsConstructor：生成全参构造器。

编译后结果：

 
 
 
 
    
  
  
  
  
  1. public static class Person { 
    2. 
  
  
  
  
  2.     @NonNull 
    3. 
  
  
  
  
  3.     private String name; 
    4. 
  
  
  
  
  4.     private int age; 
    5. 
  
  
  
  
  5.     private boolean friendly; 
    6. 
  
  
  
  
  6.     public String toString() { 
    7. 
  
  
  
  
  7.         return "TestClass.Person(name=" + this.getName() + ", age=" + this.getAge() + ")"; 
    8. 
  
  
  
  
  8.     } 
    9. 
  
  
  
  
  9.     @NonNull 
    10. 
  
  
  
  
  10.     public String getName() { 
    11. 
  
  
  
  
  11.         return this.name; 
    12. 
  
  
  
  
  12.     } 
    13. 
  
  
  
  
  13.     public int getAge() { 
    14. 
  
  
  
  
  14.         return this.age; 
    15. 
  
  
  
  
  15.     } 
    16. 
  
  
  
  
  16.     public boolean isFriendly() { 
    17. 
  
  
  
  
  17.         return this.friendly; 
    18. 
  
  
  
  
  18.     } 
    19. 
  
  
  
  
  19.     public void setName(@NonNull String name) { 
    20. 
  
  
  
  
  20.         if(name == null) { 
    21. 
  
  
  
  
  21.             throw new NullPointerException("name"); 
    22. 
  
  
  
  
  22.         } else { 
    23. 
  
  
  
  
  23.             this.name = name; 
    24. 
  
  
  
  
  24.         } 
    25. 
  
  
  
  
  25.     } 
    26. 
  
  
  
  
  26.     public void setAge(int age) { 
    27. 
  
  
  
  
  27.         this.age = age; 
    28. 
  
  
  
  
  28.     } 
    29. 
  
  
  
  
  29.     public void setFriendly(boolean friendly) { 
    30. 
  
  
  
  
  30.         this.friendly = friendly; 
    31. 
  
  
  
  
  31.     } 
    32. 
  
  
  
  
  32.     private Person() { 
    33. 
  
  
  
  
  33.     } 
    34. 
  
  
  
  
  34.     private static TestClass.Person of() { 
    35. 
  
  
  
  
  35.         return new TestClass.Person(); 
    36. 
  
  
  
  
  36.     }
    37. 
  
  
  
  
  37.     @ConstructorProperties({"name"}) 
    38. 
  
  
  
  
  38.     Person(@NonNull String name) { 
    39. 
  
  
  
  
  39.         if(name == null) { 
    40. 
  
  
  
  
  40.             throw new NullPointerException("name"); 
    41. 
  
  
  
  
  41.         } else { 
    42. 
  
  
  
  
  42.             this.name = name; 
    43. 
  
  
  
  
  43.         } 
    44. 
  
  
  
  
  44.     } 
    45. 
  
  
  
  
  45.     @ConstructorProperties({"name", "age", "friendly"}) 
    46. 
  
  
  
  
  46.     public Person(@NonNull String name, int age, boolean friendly) { 
    47. 
  
  
  
  
  47.         if(name == null) { 
    48. 
  
  
  
  
  48.             throw new NullPointerException("name");
    49. 
  
  
  
  
  49.         } else { 
    50. 
  
  
  
  
  50.             this.name = name; 
    51. 
  
  
  
  
  51.             this.age = age; 
    52. 
  
  
  
  
  52.             this.friendly = friendly; 
    53. 
  
  
  
  
  53.         } 
    54. 
  
  
  
  
  54.     } 
    55. 
  
  
  
  
  55. }
    56.

@Data：作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

@Builder：作用于类上，将类转变为建造者模式

@Log：作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：

其他重要注解：

@Cleanup：自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象

编译后结果如下：

是不是简洁了太多。

@SneakyThrows：可以对受检异常进行捕捉并抛出，可以改写上述的main方法如下：

@Synchronized：作用于方法级别，可以替换synchronize关键字或lock锁，用处不大。

网站名称：代码洁癖的春天！Java效率工具之Lombok
网页网址：http://www.csdahua.cn/qtweb/news2/115302.html

网站建设、网络推广公司-快上网，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 快上网

成都快上网为您推荐相关内容

域名注册知识

分类信息网站

崇州网站制作　　 　成都做网站　　 　路面机械及配件　　 　乐至网站建设　　 　乐山主机托管　　 　成都木托盘　　 　成都网站设计　　 　兴发搬家　　 　成都网站改版　　 　东电技服　　 　定制网站　　 　四川成都托管服务器　　 　腾讯香港虚拟主机　　 　蓬安网站建设　　 　新网创想　　 　成都做网站　　 　成都网站建设公司　　 　鑫友邦火锅桌　　 　定制级高端网站建设　　 　东电技服