1 Star 0 Fork 0

olinonee / lombok-samples

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

lombok-samples

介绍

关于lombok常用注解使用的案例。

1.先说结论

区别:

@NoArgsConstructor:生成无参的构造方法。

@AllArgsConstructor:生成该类下全部属性的构造方法。

@RequiredArgsConstructor:生成该类下被 final 修饰或者 non-null 字段生成一个构造方法。

@Data:为所有字段生成 getter、toString 方法,non-transient 字段的 hashCode 和 equals 方法,非 non-final 字段的 setter 方法和无参构造方法。@Data 等价于 @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode注解合集。

@UtilityClass:标记当前类为 final 修饰,私有无参构造方法,所有方法、内部类、所有字段都标记为 static,不允许有参构造方法。

场景:

在springboot中,对于一个bean类,注入其他bean的时候,常见的是使用@Autowired,实际上也可以使用构造函数注入,这个时候就可以使用@AllArgsConstructor或者@RequiredArgsConstructor来代替


2.代码解析区别

@NoArgsConstructor 默认都知道。若不知道怎么查看java反编译字节码内容,可以看一下: Java 如何进行反编译生成.java文件(javap、jad下载安装使用)

  1. @AllArgsConstructor
@AllArgsConstructor
public class AllArgsConstructorDemo {

    private String name;

    // 被final修饰
    private final int age;

    @NonNull
    private String sex;
}

根据反编译查看代码:

import org.springframework.lang.NonNull;

public class AllArgsConstructorDemo {
    private String name;
    private final int age;
    @NonNull
    private String sex;
    
    // 默认 只要是该类下的字段,无论什么修饰,都会被参与构造
    public AllArgsConstructorDemo(String name, int age, @NonNull String sex) {
        if (sex == null) {
            throw new NullPointerException("sex is marked non-null but is null");
        } else {
            this.name = name;
            this.age = age;
            this.sex = sex;
        }
    }
}

这是源码的英文解释: AllArgsConstructor注解源码

  1. @RequiredArgsConstructor
@RequiredArgsConstructor
public class RequiredArgsConstructorDemo {

    private String name;

    // 被final修饰
    private final int age;

    @NonNull
    private String sex;
}

反编译代码:

import org.springframework.lang.NonNull;

public class RequiredArgsConstructorDemo {
    private String name;
    private final int age;
    @NonNull
    private String sex;

    // 只构造了有final或者no-null修饰的字段
    public RequiredArgsConstructorDemo(int age, @NonNull String sex) {
        if (sex == null) {
            throw new NullPointerException("sex is marked non-null but is null");
        } else {
            this.age = age;
            this.sex = sex;
        }
    }
}

这是源码的英文解释: RequiredArgsConstructor注解源码

  1. @Data
@Data
public class DataDemo {
    private String name;
    private int age;
    private String sex;
}

反编译代码:

public class DataDemo {
    private String name;
    private int age;
    private String sex;
    public DataDemo() {}
    public String getName() {}
    public int getAge() {}
    public String getSex() {}
    public void setName(String name) {}
    public void setAge(int age) {}
    public void setSex(String sex) {}
    public boolean equals(Object o) {}
    protected boolean canEqual(Object other) {}
    public int hashCode() {}
    public String toString() {}
}

这是源码的英文解释: Data注解源码

  1. @UtilityClass
@UtilityClass
public class UtilityDemo {

    private String name;
    private int age;
    private String sex;
}

反编译代码:

public final class UtilityDemo {
    private static String name;
    private static int age;
    private static String sex;
    private UtilityDemo() {
        throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
    }
}

这是源码的英文解释: UtilityClass注解源码


3.场景使用—代替@Autowired注入bean对象

  1. @AllArgsConstructor

根据上面看反编译代码可以得出:只要是类里面字段,都会被加入到构造函数里面,不管被什么修饰。

例子:

@Component
public class BeanOne {}

@Component
public class BeanTwo {}

@Component
public class BeanThree {}

@Component
@AllArgsConstructor
@ToString
public class BeansDemo {
   // 注入三个bean对象,完全没有使用Autowired注解
   private BeanOne beanOne;

   @NonNull
   private BeanTwo beanTwo;
   
   private final BeanThree beanThree;
}

// 这只是个测试类
@Component
public class BeansRunner implements ApplicationRunner {

    @Autowired
    BeansDemo beansDemo;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(beansDemo);
    }
}

AllArgsConstructor注解运行结果 完完全全可以注入bean对象。

  1. @RequiredArgsConstructor

RequiredArgsConstructor:只会构造被final修饰或者no-null修饰的字段。

@Component
@RequiredArgsConstructor
@ToString
public class BeansDemo {

   private BeanOne beanOne;

   @NonNull
   private BeanTwo beanTwo;

   private final BeanThree beanThree;
}

RequiredArgsConstructor注解运行结果 由图可以看出,没有被修饰final或者no-null的属性无法被注入,因此,建议使用@RequiredArgsConstructor的时候,对需要的字段加上final修饰。注:强调 对需要的字段,为什么要强调,请看下面的例子:

  1. @RequiredArgsConstructor 与 @AllArgsConstructor 在注入bean上的区别

根据上面两个例子,我们可以看出无论是那种方法都可以注入bean属性对象,只是@RequiredArgsConstructor 是针对有条件的,没有什么区别。

但如果是下面的需求呢:

在该类下,部分字段还需要使用@Value来注入值呢?

@Component
@AllArgsConstructor
@ToString
public class BeansDemo {

    private BeanOne beanOne;

    @NonNull
    private BeanTwo beanTwo;

    private final BeanThree beanThree;

    @Value("${hello.name:world}")
    private String name;
}

// 先思考一下:
// 一个bean如果使用构造函数进行bean属性注入,那么当然构造函数不能加上name。
// 因为加上,在创建ConstructorDemo该bean的时候,需要找类型为String,名字是name的bean对象,当然是不存在,必然会报错。
// 因此,当然不能使用@AllArgsConstructor了,只能使用@RequiredArgsConstructor

@AllArgsConstructor例子:

@Component
@AllArgsConstructor
@ToString
public class BeansDemo {

   private BeanOne beanOne;

   @NonNull
   private BeanTwo beanTwo;

   private final BeanThree beanThree;

   // Parameter 3 of constructor in org.olinonee.framework.lombok.bean.BeansDemo required a bean of type 'java.lang.String' that could not be found.
   @Value("${hello.name:world}")
   private String name;
}

AllArgsConstructor的Value注入运行结果

@RequiredArgsConstructor的例子

@Component
@RequiredArgsConstructor
@ToString
public class BeansDemo {

    private BeanOne beanOne;

    @NonNull
    private BeanTwo beanTwo;

    private final BeanThree beanThree;

    @Value("${hello.name:world}")
    private String name;
}

RequiredArgsConstructor的Value注入运行结果


4.总结

上面只是举例了代替@Autowired的例子,实际上在json转化为对象,以及在spring中从配置文件读取配置使用@ConfigurationProperties以及@ConstructorBinding的时候,都可以使用构造函数赋值,都可以用到上面的两个@AllArgsConstructor@RequiredArgsConstructor。 具体:只要记得,哪些字段需要赋值,就把它列进构造方法的参数里面即可。


5.参考

@NoArgsConstructor、@AllArgsConstructor、@RequiredArgsConstructor的区别以及在springboot常用地方

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

关于lombok常用注解使用的案例。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/OlinOnee/lombok-samples.git
git@gitee.com:OlinOnee/lombok-samples.git
OlinOnee
lombok-samples
lombok-samples
master

搜索帮助