关于Lombok的认识及其应用(一）

目录

• 1、Lombok的介绍
• 2、Lombok的安装
• 3、Lombok实现原理分析
• 4、Lombok使用方法
  • 4.1、@Data注解
  • 4.2、@Getter/@Setter注解

1、Lombok的介绍

​ Lombok是一款Java开发插件，使得Java开发者可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码，尤其对于简单的Java模型对象（POJO）。在开发环境中使用Lombok插件后，Java开发人员可以节省出重复构建，诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。对于这些方法，它能够在编译源代码期间自动帮我们生成这些方法，并没有如反射那样降低程序的性能。

2、Lombok的安装

注意 ：主要基于IDEA开发软件（也不是安装，只是添加插件或依赖）

如何找到如下图的插件：Files->Settings->Plugins，然后搜索Lombok

另外需要注意的是，在使用lombok注解的时候记得要导入lombok.jar包到工程，如果使用的是Maven的工程项目的话，要在其pom.xml中添加依赖如下：

<!--版本申明-->
<lombok.version>1.6.18</lombok.version>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>${lombok.version}</version>
    <scope>provided</scope>
</dependency>

3、Lombok实现原理分析

1、其开发是遵循JSR 269 Pluggable Annotation Processing API；
2、而javac从java6开始支持“JSR 269 API”规范；
3、即只要程序实现了该API，就能在javac运行的时候得到调用；
4、Lombok实现了“JSR 269 API”。

在编译时，javac编译源码的具体流程如下：

4、Lombok使用方法

​ Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误。

​ Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。出现的神奇就是在源码中没有getter和setter方法，但是在编译生成的字节码文件中有getter和setter方法。这样就省去了手动重建这些代码的麻烦，使代码看起来更简洁些。

4.1、@Data注解

​ @Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

不使用@Data注解代码如下：

package org.mrzhangxd.com.springboot_vue_exam.entry;
/**
 * @Project: springboot_vue_exam
 * @Description:
 * @Package: org.mrzhangxd.com.springboot_vue_exam.entry
 * @Create by 张小东 on 2019/11/24 19:00
 */
public class Admin {
    /** 版本号 */
    private static final long serialVersionUID = -5661933053710306924L;

    /** 管理员ID */
    private Integer adminId;

    /** 管理员姓名 */
    private String adminName;

    /** 管理员性别 */
    private String adminSex;

    /** 管理员电话号码 */
    private String adminTel;

    /** 管理员邮箱 */
    private String adminEmail;

    /** 密码 */
    private String adminPwd;

    /** 身份证号 */
    private String adminCardnum;

    /** 角色（0管理员，1教师，2学生） */
    private String adminRole;

    /**
     * 获取管理员ID
     *
     * @return 管理员ID
     */
    public Integer getAdminId() {
        return adminId;
    }

    /**
     * 设置管理员ID
     *
     * @param adminId
     *          管理员ID
     */
    public void setAdminId(Integer adminId) {
        this.adminId = adminId;
    }

    /**
     * 获取管理员姓名
     *
     * @return 管理员姓名
     */
    public String getAdminName() {
        return this.adminName;
    }
    /**
     * 设置管理员姓名
     *
     * @param adminName
     *          管理员姓名
     */
    public void setAdminName(String adminName) {
        this.adminName = adminName == null ? null : adminName.trim();
    }

    /**
     * 获取管理员性别
     *
     * @return 管理员性别
     */
    public String getAdminSex() {
        return adminSex;
    }

    /**
     * 设置管理员性别
     *
     * @param adminSex
     * 管理员性别
     */
    public void setAdminSex(String adminSex) {
        this.adminSex = adminSex ==  null ? null : adminSex.trim();
    }

    /**
     * 获取管理员电话号码
     *
     * @return 管理员电话号码
     */
    public String getAdminTel() {
        return adminTel;
    }

    /**
     * 设置管理员电话号码
     *
     * @param adminTel
     *          管理员电话号码
     */
    public void setAdminTel(String adminTel) {
        this.adminTel = adminTel == null ? null : adminTel.trim();
    }

    /**
     * 获取管理员邮箱
     *
     * @return 管理员邮箱
     */
    public String getAdminEmail() {
        return this.adminEmail;
    }

    /**
     * 设置管理员邮箱
     *
     * @param adminEmail
     *          管理员邮箱
     */
    public void setAdminEmail(String adminEmail) {
        this.adminEmail = adminEmail == null ? null : adminEmail.trim();
    }

    /**
     * 获取密码
     *
     * @return 密码
     */
    public String getAdminPwd() {
        return adminPwd;
    }

    /**
     * 设置密码
     *
     * @param adminPwd
     *          密码
     */
    public void setAdminPwd(String adminPwd) {
        this.adminPwd = adminPwd == null ? null : adminPwd.trim();
    }

    /**
     * 获取身份证号
     *
     * @return 身份证号
     */
    public String getAdminCardnum() {
        return adminCardnum;
    }

    /**
     * 设置身份证号
     *
     * @param adminCardnum
     *          身份证号
     */
    public void setAdminCardnum(String adminCardnum) {
        this.adminCardnum = adminCardnum == null ? null : adminCardnum.trim();
    }

    /**
     * 获取角色（0管理员，1教师，2学生）
     *
     * @return 角色（0管理员
     */
    public String getAdminRole() {
        return adminRole;
    }

    /**
     * 设置角色（0管理员，1教师，2学生）
     *
     * @param adminRole
     *          角色（0管理员
     */
    public void setAdminRole(String adminRole) {
        this.adminRole = adminRole == null ? null : adminRole.trim();
    }
}

使用@Data注解后代码：

package org.mrzhangxd.com.springboot_vue_exam.entry;

import lombok.Data;
/**
 * @Project: springboot_vue_exam
 * @Description:
 * @Package: org.mrzhangxd.com.springboot_vue_exam.entry
 * @Create by 张小东 on 2019/11/24 19:00
 */
@Data
public class Admin {

    /** 管理员ID */
    private Integer adminId;

    /** 管理员姓名 */
    private String adminName;

    /** 管理员性别 */
    private String adminSex;

    /** 管理员电话号码 */
    private String adminTel;

    /** 管理员邮箱 */
    private String adminEmail;

    /** 密码 */
    private String adminPwd;

    /** 身份证号 */
    private String adminCardnum;

    /** 角色（0管理员，1教师，2学生） */
    private String adminRole;
}

4.2、@Getter/@Setter注解

如果觉得@Data太过残暴（因为@Data集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性）不够精细，可以使用@Getter/@Setter注解，此注解在属性上，可以为相应的属性自动生成Getter/Setter方法，示例如下：

package org.mrzhangxd.com.springboot_vue_exam.entry;

import lombok.Setter;
import lombok.getter;
/**
 * @Project: springboot_vue_exam
 * @Description:
 * @Package: org.mrzhangxd.com.springboot_vue_exam.entry
 * @Create by 张小东 on 2019/11/24 19:00
 */
public class Demo1{
    @Getter
    @Setter
    private String username;
    @Getter
    @Setter
    private String password;

    @Override
    public String toString(){
        return String.format(username,password);
    }
}

不使用@Getter/@Setter注解的代码：

package org.mrzhangxd.com.springboot_vue_exam.entry;

import lombok.
/**
 * @Project: springboot_vue_exam
 * @Description:
 * @Package: org.mrzhangxd.com.springboot_vue_exam.entry
 * @Create by 张小东 on 2019/11/24 19:00
 */
 public class Demo{
     /** 用户名*/
     private String username;
     /** 密码*/
     private String password;

     /**
     * 获取用户名
     * @return 用户名
     */
     public String getUsername(){

         return username;

     }

     /**
     * 设置用户名
     *
     * @param Username
     *          用户名
     */
     public void setUsername(String username){

         this.Username = username;

     }
     /**
     * 获取用户密码
     * @return 用户密码
     */
     public String getPassword(){

         return username;

     }

     /**
     * 设置用户密码
     *
     * @param Password
     *          用户密码
     */
     public void setPssword(String password){

         this.Pasword = password;

     }

 }

​

后续更新... ...