SpringBoot (五) 集成 lombok简化代码

有勇气的牛排 526 Java 2023-02-25 13:24:40

文章目录

前言
1 配置
2 常用注解
2 Java代码案例

前言

哈喽，大家好，我是有勇气的牛排（全网同名）🐮🐮🐮

有问题的小伙伴欢迎在文末评论，点赞、收藏是对我最大的支持！！！。

官网：https://www.couragesteak.com/

Lombok项目是一个java库，它可以自动插入到编辑器和构建工具中，增强java的性能。不需要再写getter、setter或equals方法，只要有一个注解，你的类就有一个功能齐全的构建器、自动记录变量等等

lombok官网：https://projectlombok.org/features/

1 配置

Maven依赖 :

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.RELEASE</version>
    </parent>
    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>

idea安装lombok插件 :

File–>Setting–>Plugins–>搜索“lombok plugin”，安装后重启ide

2 常用注解

@Data：注解在类上，提供类所有属性的getting和setting方法，它还提供了equals、canEqual、hashCode、toString方法。
@Setter：注解在属性上，为属性提供 setting 方法。
@Getter：注解在属性上，为属性提供 getting 方法。
@Log4j：注解在类上，为类提供一个名为log的log4j日志对象。
@NoArgsConstructor：注解在类上，为类提供一个无参构造方法。
@AllArgsConstructor：注解在类上，为类提供全参构造方法。
@NonNull：注解在参数上，可以省略重复的 if(null == persion) 这类异常处理。
@Cleanup：注解在输入输出流等需要释放资源的变量上，不需要写额外繁琐而重复的释放资源代码。

2 Java代码案例

/*
 * @Author  : 有勇气的牛排
 * @FileName: UserEntity.java
 * desc     :
 * */

package com.couragesteak.test;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;

@Data
@Slf4j
public class UserEntity {

    private Integer id;
    private String userName;
    private Integer age;

    public UserEntity() {
    }

    public UserEntity(Integer id, String userName, Integer age) {
        this.id = id;
        this.userName = userName;
        this.age = age;
    }

    @Override
    public String toString() {
        return "UserEntity{" +
                "id=" + id +
                ", userName='" + userName + '\'' +
                ", age=" + age +
                '}';
    }

    public static void main(String[] args) {
        log.info("========cs=======");
        UserEntity userEntity = new UserEntity(1,"有勇气的牛排",20);
        System.out.println(userEntity.toString());
        System.out.println(userEntity.getUserName());
    }
}

如果不适用lombok打印日志

private Logger log = Logger.getLogger(UserEntity.class);

参考地址：
[1] 余胜军
[2] https://developer.aliyun.com/article/319220

<h3>文章目录</h3><ul><ul><li><a href="#_2">前言</a></li><li><a href="#1__14">1 配置</a></li><li><a href="#2__44">2 常用注解</a></li><li><a href="#2_Java_56">2 Java代码案例</a></li></ul></ul> <h2><a id="_2"></a>前言</h2> 哈喽，大家好，我是有勇气的牛排（全网同名）🐮🐮🐮 有问题的小伙伴欢迎在文末评论，点赞、收藏是对我最大的支持！！！。 官网：<a href="https://www.couragesteak.com/" target="_blank">https://www.couragesteak.com/</a> Lombok项目是一个java库，它可以自动插入到编辑器和构建工具中，增强java的性能。不需要再写getter、setter或equals方法，只要有一个注解，你的类就有一个功能齐全的构建器、自动记录变量等等 lombok官网：https://projectlombok.org/features/ <h2><a id="1__14"></a>1 配置</h2> Maven依赖 : <pre><div class="hljs"><code class="lang-xml"> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.8.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>  <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> </dependencies> </code></div></pre> idea安装lombok插件 : File–>Setting–>Plugins–>搜索“lombok plugin”，安装后重启ide <h2><a id="2__44"></a>2 常用注解</h2> <code>@Data</code>：注解在类上，提供类所有属性的<code>getting</code>和<code>setting</code>方法，它还提供了<code>equals</code>、<code>canEqual</code>、<code>hashCode</code>、<code>toString</code>方法。 <code>@Setter</code>：注解在属性上，为属性提供 setting 方法。 <code>@Getter</code>：注解在属性上，为属性提供 getting 方法。 <code>@Log4j</code>：注解在类上，为类提供一个名为log的log4j日志对象。 <code>@NoArgsConstructor</code>：注解在类上，为类提供一个无参构造方法。 <code>@AllArgsConstructor</code>：注解在类上，为类提供全参构造方法。 <code>@NonNull</code>：注解在参数上，可以省略重复的 <code>if(null == persion)</code> 这类异常处理。 <code>@Cleanup</code>：注解在输入输出流等需要释放资源的变量上，不需要写额外繁琐而重复的释放资源代码。 <h2><a id="2_Java_56"></a>2 Java代码案例</h2> <pre><div class="hljs"><code class="lang-java">/* * @Author : 有勇气的牛排 * @FileName: UserEntity.java * desc : * */ package com.couragesteak.test; import lombok.Data; import lombok.extern.slf4j.Slf4j; @Data @Slf4j public class UserEntity { private Integer id; private String userName; private Integer age; public UserEntity() { } public UserEntity(Integer id, String userName, Integer age) { this.id = id; this.userName = userName; this.age = age; } @Override public String toString() { return "UserEntity{" + "id=" + id + ", userName='" + userName + '\'' + ", age=" + age + '}'; } public static void main(String[] args) { log.info("========cs======="); UserEntity userEntity = new UserEntity(1,"有勇气的牛排",20); System.out.println(userEntity.toString()); System.out.println(userEntity.getUserName()); } } </code></div></pre> <img src="https://static.couragesteak.com/article/72b0cc500aa1e31abe29dd462402a413.png" alt="image.png" /> 如果不适用lombok打印日志 <pre><div class="hljs"><code class="lang-java">private Logger log = Logger.getLogger(UserEntity.class); </code></div></pre> 参考地址： [1] 余胜军 [2] https://developer.aliyun.com/article/319220