详细分析Java中@RequiredArgsConstructor注解的基本知识（附Demo）

🕗 发布于 2024-11-26 21:07 java lombok ArgsConstructor 注解

前言

从源码中学习，事因是看到项目代码中有所引用

@RequiredArgsConstructor 是 Lombok 提供的一个注解，用于自动生成一个包含所有 final 字段和带有 @NonNull 注解字段的构造函数

这可以减少样板代码，尤其是在需要依赖注入时

对于Java的基本知识，推荐阅读：

1. 基本知识

Lombok 是一个 Java 库，通过注解简化代码
常用注解包括 @Getter, @Setter, @ToString, @EqualsAndHashCode, 和 @Data 等

针对@RequiredArgsConstructor 注解会生成一个包含所有 final 字段和带有 @NonNull 注解字段的构造函数
这对于构造必须初始化这些字段的对象非常有用

基本的语法如下：

@RequiredArgsConstructor
public class MyClass {
    private final String name;
    private final int age;
    private String address;
    
    @NonNull
    private String phoneNumber;
}

对应生成的构造函数如下：

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

对应需要注意的事项如下：

字段的顺序：生成的构造函数中的参数顺序是按照字段在类中定义的顺序
@NonNull 注解：如果某个字段带有 @NonNull 注解，它也会包含在构造函数中，即使它不是 final 的。
与其他构造函数冲突：如果手动定义了构造函数，@RequiredArgsConstructor 生成的构造函数可能会与其冲突
与其他注解比较：
@NoArgsConstructor：生成一个无参构造函数。
@AllArgsConstructor：生成一个包含所有字段（包括非 final 字段）的构造函数

2. 源码解读

先看源码的对应属性

在这里插入图片描述

对应的属性分析如下：

staticName:
设置了这个属性，会生成一个静态方法，该方法调用私有构造函数
这个静态方法主要用于推断类型参数
onConstructor:
允许在生成的构造函数上添加指定的注解
JDK 7 和 JDK 8 的语法稍有不同。
access:
设置构造函数的访问级别
默认是 public，可以设置为 private, protected 或 package

针对源码结合以下Demo进行展示

3. Demo

3.1 简易Demo

import lombok.NonNull;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class test {
    private final String firstName;
    private final String lastName;
    @NonNull
    private String email;
    private int age;

    public static void main(String[] args) {
        // 正确使用示例
        test person = new test("码农", "研究僧", "https://blog.csdn.net/weixin_47872288");
        System.out.println("Person created: " + person);

        // 错误使用示例（会导致编译错误）
        // Person person2 = new Person("Jane", "Doe");
    }

    @Override
    public String toString() {
        return "Person{" +
                "firstName='" + firstName + '\'' +
                ", lastName='" + lastName + '\'' +
                ", email='" + email + '\'' +
                ", age=" + age +
                '}';
    }
}

明确需要3个属性，不可超过4个

在这里插入图片描述

再者对应的字段属性是按照顺序的，如果更换顺序会出现如下场景：test person = new test("码农","https://blog.csdn.net/weixin_47872288","研究僧");
在这里插入图片描述

3.2 staticName属性

@RequiredArgsConstructor(staticName = "of") 会生成一个静态方法 of 来实例化对象，而不是直接调用构造函数

import lombok.AllArgsConstructor;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor(staticName = "of")
public class test {
    private final String firstName;

    private final String lastName;
    private final String email;

    public static void main(String[] args) {
        test example = test.of("码农","研究僧","https://blog.csdn.net/weixin_47872288");
        System.out.println(example);
    }

    @Override
    public String toString() {
        return "StaticConstructorExample{" +
                "firstName='" + firstName + '\'' +
                ", lastName='" + lastName + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

截图如下：

在这里插入图片描述

3.3 onConstructor属性

@RequiredArgsConstructor(onConstructor_ = @__(@CustomAnnotation("Custom Constructor"))) 会在生成的构造函数上添加 @CustomAnnotation

import lombok.AllArgsConstructor;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
@interface CustomAnnotation {
    String value();
}
@RequiredArgsConstructor(onConstructor_ = @__(@CustomAnnotation("Custom Constructor")))
public class test {
    private final String firstName;

    private final String lastName;
    private final String email;

    public static void main(String[] args) {
        test example = new test("码农","研究僧","https://blog.csdn.net/weixin_47872288");
        System.out.println(example);
    }

    @Override
    public String toString() {
        return "StaticConstructorExample{" +
                "firstName='" + firstName + '\'' +
                ", lastName='" + lastName + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

3.4 access属性

@RequiredArgsConstructor(access = AccessLevel.PRIVATE, staticName = "of")
public class test {
    private final String firstName;

    private final String lastName;
    private final String email;

    public static void main(String[] args) {
        test example = test.of("码农", "研究僧", "https://blog.csdn.net/weixin_47872288");
        System.out.println(example);
    }

    @Override
    public String toString() {
        return "StaticConstructorExample{" +
                "firstName='" + firstName + '\'' +
                ", lastName='" + lastName + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

不需要构造函数是私有的，可以将构造函数的访问级别设置为 public 或 protected，直接进行new

但是我的private它竟然可以new（神奇=-=）

在这里插入图片描述

4. @AllArgsConstructor比较

使用 @RequiredArgsConstructor 时，只有 final 字段和 @NonNull 字段会被初始化
但是@AllArgsConstructor 生成一个构造函数，该构造函数包含类中所有字段，无论它们是否为 final 或带有 @NonNull 注解

@AllArgsConstructor
public class test {
    private final String firstName;
    private  String lastName;
    @NonNull
    private String email;
    private int age;

    public static void main(String[] args) {
        // 正确使用示例
        test person = new test("码农","研究僧","https://blog.csdn.net/weixin_47872288",18);
        System.out.println("Person created: " + person);

        // 错误使用示例（会导致编译错误）
        // Person person2 = new Person("Jane", "Doe");
    }

    @Override
    public String toString() {
        return "Person{" +
                "firstName='" + firstName + '\'' +
                ", lastName='" + lastName + '\'' +
                ", email='" + email + '\'' +
                ", age=" + age +
                '}';
    }
}

截图如下：（必须要有四个参数）

在这里插入图片描述

这两者都可以实用构造函数注入，但推荐使用@RequiredArgsConstructor，因为它只会初始化那些在创建对象时必需的字段

原文地址：https://blog.csdn.net/weixin_47872288/article/details/139940033

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：C# Dictionary实现原理
下一篇：JavaScript第一课！—变量，数据类型，运算符，程序控制语句用法大全

Linux线程（Linux和Windows的线程区别、Linux的线程函数、互斥、同步）
**线程的概念**：**线程是 CPU 调度的基本单位**。它被包含在进程之中，**是进程中的实际运作单位**。一条线程指的是进程中一个单一顺序的控制流，一个进程中可以并发多个线程，每条线程并行执行不
阅读更多2024-11-27
maven-compiler-plugin插件介绍
Maven Compiler Plugin 用于编译Java源文件。它利用javac编译器将.java文件转换成.class文件，这些文件可由Java虚拟机(JVM)执行。通过配置此插件，可以指定JD
阅读更多2024-11-27
美团面试：有哪些情况会产生死锁
我们首先需要知道，死锁一定发生在并发场景中。为了保证线程安全，有时会给程序使用各种能保证并发安全的工具，尤其是锁，但是如果在加解锁过程中处理不恰当，就有可能适得其反，导致程序出现死锁的情况。什么是死锁
阅读更多2024-11-27
fastjson不出网打法—BCEL链
BCEL的全名应该是Apache Commons BCEL，它是一个库。这个库里面有类叫com.sun.org.apache.bcel.internal.util，而这个类里面有一个classLoad
阅读更多2024-11-27
深度学习——3种常见的Transformer位置编码【sin/cos、基于频率的二维位置编码（2D Frequency Embeddings）、RoPE】
介绍3种常见的Transformer位置编码——正弦/余弦位置编码（sin/cos）、基于频率的二维位置编码（2D Frequency Embeddings）、旋转式位置编码（RoPE）
阅读更多2024-11-27
【作业九】RNN-SRN-Seq2Seq
单步处理RNNCell是最基本的RNN单元，只处理单个时间步的数据。要处理整个序列，需要在外部循环中逐个时间步地调用RNNCell。input_size(int): 输入特征的维度。(int): 隐藏
阅读更多2024-11-27
加快训练LLM速度的技巧笔记
解释：如下图，相比fp32，bf16的表示范围不变（还是e8），但精度从m23降到了m7，但在大模型训练时，这种精度损失是可接受的。需要注意，有些老的gpu不支持这个操作。一些新一点的4090，A10
阅读更多2024-11-27
Linux -线程互斥与同步
Linux -线程互斥与同步
阅读更多2024-11-27
BERT 详解
BERT（Bidirectional Encoder Representations from Transformers）是由 Google 在 2018 年提出的一种预训练语言模型。BERT 在自然
阅读更多2024-11-27
如何优化 Python 爬虫的速度
【代码】如何优化 Python 爬虫的速度。
阅读更多2024-11-27

详细分析Java中@RequiredArgsConstructor注解的基本知识（附Demo）

目录

前言

1. 基本知识

2. 源码解读

3. Demo

3.1 简易Demo

3.2 staticName属性

3.3 onConstructor属性

3.4 access属性

4. @AllArgsConstructor比较

相关文章