Java常用依赖简介——lombok

最新推荐文章于 2024-04-14 23:47:42 发布

╭⌒若隐_RowYet——大数据

最新推荐文章于 2024-04-14 23:47:42 发布

阅读量4.7k

点赞数 2

分类专栏： Java 文章标签： java

本文链接：https://blog.csdn.net/LXWalaz1s1s/article/details/108247285

版权

Java 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

背景

在传统的Java编程中，构建一个对象类，常常需要写对象的变量的get，set，toString等方法如下代码，这些样板代码既没有技术含量，又影响着代码的美观，于是就有了lombok的产生，只需要添加几个注释，就可以帮你在编译的时候自动生成这些代码，灰常的友好！

class Stutent
{
    private String name;
    private int age;

    public String getName() 
    {
        return name;
    }

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

    public int getAge() 
    {
        return age;
    }

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

lombok的官网

官网：https://projectlombok.org/
官网简介：Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java. Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.
意思就是lombok是个java的库，自动插入到编辑器和工具中，主需要添加几行注释就可让你永远不用自己写getter或equals等方法，高效而且高性能；实际上，用过的人也都知道lombok确实如此。

lombok的添加

lombok的使用灰常简单，因为大家也清楚，毕竟设计的太麻烦，那还不如老老实实写那几句没营养的代码呢；

一、添加lombok的maven包

进入maven的repository网站，maven repository，在search的文本框内输入lombok，选择Project Lombok点进去，如图1，相信群众，选一个版本使用人数最多的，点击一下版本号1.18.12，进入图2；
在这里插入图片描述

图1 引用maven包

在图2处，把下面的maven依赖copy到Java的maven配置文件pom.xml即可；

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope>
</dependency>

在这里插入图片描述

图2 lombok的maven配置

二、安装lombok插件

光有依赖包还不行，编译的时候需要把一些之前说到的没营养的代码自动生成出来，所以编译依赖插件；
这里以IDE为例，打开IntelliJ IDEA,点击菜单栏的File，选择settings，跳出如图3的界面，选择Plugins,在查询框内输入lombok就出来了，直接点击Install就行了，装好后IntelliJ IDEA需要重启下，一般会自动重启，如果再次来到这个界面，就会显示Installed了。
在这里插入图片描述

图3 lombok插件安装

lombok的使用

添加好maven依赖包和安装好插件后，lombok就能正常使用了，其实我们主要使用他的POJO类注解，举例如下；
拿开局的class Student对象类来举例，如果我们不使用lombok，那么单纯的只是定义了两个变量，代码如下，注意观察该对象类的Structure，如图4；
在这里插入图片描述

图4 单纯的定义两个变量

这里我们只需要引入下lombok的包，加一下@Data的注释，就可以自动生成变量的set，get，toString等代码了和函数了，具体如图5，神奇不？
在这里插入图片描述

图5 加了lombok后的魔力下面例举些常用的Lombok注解：

@Getter/@Setter: 作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等;
@ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段;
@EqualsAndHashCode：作用于类，覆盖默认的equals和hashCode;
@NonNull：主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常;
@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：作用于类上，用于生成构造函数。有staticName、access等属性。
@NoArgsConstructor：生成无参构造器；
@RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；
@AllArgsConstructor：生成全参构造器
@Data：作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
@Builder：作用于类上，将类转变为建造者模式
@Log：作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：
@Slf4j：作用于类上，主要用来调用log.info(" your text")输出日志，代替System.out.println的输出。
@Cleanup：自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象
@SneakyThrows：可以对受检异常进行捕捉并抛出，可以改写上述的main方法如下：
@Synchronized：作用于方法级别，可以替换synchronize关键字或lock锁，用处不大.

而其中@NoArgsConstructor,@AllArgsConstructor,@Data相对用的最多，要熟悉掌握，更多的注释用法，可以参考官网Lombok features;

代码迁移后lombok解惑

疑问：如果我的代码写完，需要编译然后打包成Jar移植到别的服务器上，别的服务器是否也需要安装lombok的maven依赖和lombok插件呢？
答案：完全不必，之前说过，为啥需要下载lombok插件，原因就是因为你在编译的时候，lombok插件会根据注释帮你编译好这些代码，你也可以查看编译后的Student.class文件就会发现，这些代码已经自动生成了,具体如下，当然如果你的源码copy给别人，反而是需要别人装lombok插件的，同时检查下maven的依赖包是否有配置好。

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package com.ruoyin.entity;

public class Student {
    private String name;
    private int age;

    public String getName() {
        return this.name;
    }

    public int getAge() {
        return this.age;
    }

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

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

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Student)) {
            return false;
        } else {
            Student other = (Student)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                Object this$name = this.getName();
                Object other$name = other.getName();
                if (this$name == null) {
                    if (other$name == null) {
                        return this.getAge() == other.getAge();
                    }
                } else if (this$name.equals(other$name)) {
                    return this.getAge() == other.getAge();
                }

                return false;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof Student;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $name = this.getName();
        int result = result * 59 + ($name == null ? 43 : $name.hashCode());
        result = result * 59 + this.getAge();
        return result;
    }

    public String toString() {
        return "Student(name=" + this.getName() + ", age=" + this.getAge() + ")";
    }

    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public Student() {
    }
}

lombok的坑

当然，任何技术本身都是为了解决一类问题，如果过渡乱用，就背离Java本身，lombok也有自身的缺点，如下；

你的源码copy给别人，反而是需要别人装lombok插件的，同时检查下maven的依赖包是否有配置好，否则会报错；
如果你定义的boolean类型的对象类变量，又是以is开头，会显得很不友好，is会和lombok注释生成的属性有冲突，会改写你的函数名等，自己坑自己，如图6，解决方法就是尽量避免boolean类型的变量又用is开头。

图6 boolean类型的变量is开头效果

在使用 @Slf4j时，可能出现运行时的警告，非常的烦；

log4j:WARN No appenders could be found for logger (cn.focusmedia.esapp.feign.EsClient).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.

解决方法：src/main/新建resources文件夹，如果有就不要建了，新建个文件log4j.properties,内容如下；

log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%5p - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=firestorm.log

log4j.appender.R.MaxFileSize=100KB
log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

log4j.logger.com.codefutures=DEBUG

╭⌒若隐_RowYet——大数据

关注

2
点赞
踩
12

收藏

觉得还不错? 一键收藏
打赏
0
评论
Java常用依赖简介——lombok

背景在传统的Java编程中，构建一个对象类，常常需要写对象的变量的get，set，toString等方法如下代码，这些样板代码既没有技术含量，又影响着代码的美观，于是就有了lombok的产生，只需要添加几个注释，就可以帮你在编译的时候自动生成这些代码，灰常的友好！class Stutent{ private String name; private int age; public String getName() { return name;
复制链接

扫一扫