详解SpringBoot优雅编码之Lombok加持

 更新时间:2018年06月11日 10:49:31   作者:CodeSheep  
这篇文章主要介绍了详解SpringBoot优雅编码之Lombok加持,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

本文介绍了SpringBoot优雅编码之Lombok加持,分享给大家,具体如下:

概述

Lombok 通过提供简单的语法注解形式来帮助简化消除一些必须有但显得很臃肿的 java 代码。典型的是对于 POJO对象的简化(如自动帮我们生成Setter和Getter等),有了Lombok的加持,开发人员可以免去很多重复且臃肿的操作,极大地提高java代码的信噪比,因此我们必须尝试并应用起来!

IntelliJ IDEA上配置

方法一:直接在IDEA界面中配置

首先进入Plugins界面:

然后搜索并安装Lombok插件:

最后不要忘了开启Annotation Processors的Enable选项:

上述安装完成以后需要重启IDEA生效!

方法二:手动下载Lombok插件安装

有时由于网络原因,上面方法一这种方式安装失败,因此只能手动下载安装

下载lombok插件:

https://github.com/mplushnikov/lombok-intellij-plugin/releases

Plugins -> Install plugin from disk... 选择下载的zip包安装

重启idea即可

IDE中设置完成以后需要在pom.xml中添加如下所示的lombok依赖才能使用

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

Lombok主要注解

  1. @Getter and @Setter / 自动为属性提供 Set和Get 方法
  2. @ToString / 该注解的作用是为类自动生成toString()方法
  3. @EqualsAndHashCode / 为对象字段自动生成hashCode和equals实现
  4. @AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor / 顾名思义,为类自动生成对应参数的constructor
  5. @Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, @JBossLog / 自动为类添加对应的log支持
  6. @Data / 自动为所有字段添加@ToString, @EqualsAndHashCode, @Getter,为非final字段添加@Setter,和@RequiredArgsConstructor,本质上相当于几个注解的综合效果
  7. @NonNull / 自动帮助我们避免空指针。作用在方法参数上的注解,用于自动生成空值参数检查
  8. @Cleanup / 自动帮我们调用close()方法。作用在局部变量上,在作用域结束时会自动调用close方法释放资源

下文就Lombok中用的最为频繁的@Data@Log注解进行代码实战!

@Data注解使用

官网关于@Data注解的解释如下:

All together now: A shortcut for @ToString, @EqualsAndHashCode, @Getter on all fields, @Setter on all non-final fields, and @RequiredArgsConstructor!

不难理解,其可以看成是多个Lombok注解的集成,因此使用很方便!

先来创建一个POJO实体UserLombok,普通的写法如下:

public class UserLombok {
 private final String name;
 private int age;
 private double score;
 private String[] tags;
 
 public UserLombok(String name) {
  this.name = name;
 }
 
 public String getName() {
  return this.name;
 }
 
 void setAge(int age) {
  this.age = age;
 }
 
 public int getAge() {
  return this.age;
 }
 
 public void setScore(double score) {
  this.score = score;
 }
 
 public double getScore() {
  return this.score;
 }
 
 public String[] getTags() {
  return this.tags;
 }
 
 public void setTags(String[] tags) {
  this.tags = tags;
 }
 
 @Override public String toString() {
  return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + “)”;
 }
 
 protected boolean canEqual(Object other) {
  return other instanceof DataExample;
 }
 
 @Override public boolean equals(Object o) {
  if (o == this) return true;
  if (!(o instanceof DataExample)) return false;
  DataExample other = (DataExample) o;
  if (!other.canEqual((Object)this)) return false;
  if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
  if (this.getAge() != other.getAge()) return false;
  if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
  if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
  return true;
 }
 
 @Override public int hashCode() {
  final int PRIME = 59;
  int result = 1;
  final long temp1 = Double.doubleToLongBits(this.getScore());
  result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
  result = (result*PRIME) + this.getAge();
  result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
  result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
  return result;
 }
}

Lombok加持后,写法可简化为:

@Data
public class UserLombok {
  private final String name;
  private int age;
  private double score;
  private String[] tags;
}

在IDEA中使用时,Lombok的注解会自动补全,如下图所示:

我们来写POJO的测试代码

public static void main( String[] args ) {
    UserLombok userLombok = new UserLombok("hansonwang99”);
    userLombok.setAge(18);
    String[] array = new String[]{"apple","juice”};
    userLombok.setTags( array );
    userLombok.setScore( 99.0 );
    System.out.println(userLombok);
  }

由下图我们可以看到IDEA依然可以自动为我们补全由Lombok自动生成的代码:

结果打印

由于Lombok为我们自动生成了toString方法,因此对象的打印结果如下:

UserLombok(name=hansonwang99, age=18, score=99.0, tags=[apple, juice])

@Log注解实战

在我的文章 Spring Boot日志框架实践 一文中,我们使用Log4j2来作为日志对象,其写法如下:

@RestController
@RequestMapping("/testlogging”)
public class LoggingTestController {

  private final Logger logger = LogManager.getLogger(this.getClass());

  @GetMapping("/hello”)
  public String hello() {
    for(int i=0;i<10_0000;i++){
      logger.info("info execute index method”);
      logger.warn("warn execute index method”);
      logger.error("error execute index method”);

    }

    return "My First SpringBoot Application”;
  }
}

若改用Lombok后,写法变得更加简洁,我们只需要引入对应的@Log注解即可完成log对象的生成:

@RestController
@RequestMapping("/testloggingwithlombok”)
@Log4j2
public class LoggingTestControllerLombok {

  @GetMapping("/hello”)
  public String hello() {
    for(int i=0;i<10_0000;i++){
      log.info("info execute index method”);
      log.warn("warn execute index method”);
      log.error("error execute index method”);

    }

    return "My First SpringBoot Application”;
  }
}

怎么样,是不是一切都是那么地优雅!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Java实现文件分片上传接口的示例代码

    Java实现文件分片上传接口的示例代码

    这篇文章主要为大家详细介绍了如何利用Java语言实现文件分片上传的功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起了解一下
    2022-07-07
  • J2EE基础之EJB全面了解

    J2EE基础之EJB全面了解

    下面小编就为大家带来一篇J2EE基础之EJB全面了解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-07-07
  • 五个Java中线程池使用不当的避坑指南

    五个Java中线程池使用不当的避坑指南

    线程池是 Java 多线程编程中的一个重要概念,它可以有效地管理和复用线程资源,提高系统的性能和稳定性,本文将介绍线程池使用不当的五个坑,以及如何避免和解决它们,希望对大家有所帮助
    2024-02-02
  • java从list中取出对象并获得其属性值的方法

    java从list中取出对象并获得其属性值的方法

    这篇文章主要介绍了java从list中取出对象并获得其属性值的方法,大家参考使用
    2013-12-12
  • springboot接收JSON实现示例解析

    springboot接收JSON实现示例解析

    这篇文章主要为大家介绍了springboot如何接收JSON的实现示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07
  • Java毕业设计实战之在线网盘系统的实现

    Java毕业设计实战之在线网盘系统的实现

    这是一个使用了java+JSP+Springboot+maven+mysql+ThymeLeaf+FTP开发的在线网盘系统,是一个毕业设计的实战练习,具有网盘该有的所有功能,感兴趣的朋友快来看看吧
    2022-01-01
  • Java基础教程之HashMap迭代删除使用方法

    Java基础教程之HashMap迭代删除使用方法

    这篇文章主要给大家介绍了关于Java基础教程之HashMap迭代删除使用方法的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Java具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-05-05
  • Java HttpClient技术详解

    Java HttpClient技术详解

    Http协议的重要性相信不用我多说了,HttpClient相比传统JDK自带的URLConnection,增加了易用和灵活性(具体区别,日后我们再讨论),它不仅是客户端发送Http请求变得容易,而且也方便了开发人员测试接口(基于Http协议的),即提高了开发的效率,也方便提高代码的健壮性
    2021-10-10
  • SpringBoot开发中的数据源详解

    SpringBoot开发中的数据源详解

    这篇文章主要介绍了SpringBoot开发中的数据源详解,数据源(Data Source)顾名思义,数据的来源,是提供某种所需要数据的器件或原始媒体,在数据源中存储了所有建立数据库连接的信息,需要的朋友可以参考下
    2023-09-09
  • 解决java.sql.SQLException:索引中丢失 IN或OUT 参数::x问题

    解决java.sql.SQLException:索引中丢失 IN或OUT 参数::x问题

    这篇文章主要介绍了解决java.sql.SQLException:索引中丢失 IN或OUT 参数::x问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12

最新评论