前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Java代码中写set/get方法了,逮到罚款!

Java代码中写set/get方法了,逮到罚款!

作者头像
程序员小猿
发布于 2021-01-19 04:22:07
发布于 2021-01-19 04:22:07
58600
代码可运行
举报
文章被收录于专栏:程序IT圈程序IT圈
运行总次数:0
代码可运行

作者:Mr.ml

来源:blog.csdn.net/MarcoAsensio/article/details/103654691

前言

what?你的 Java 代码中还充斥着大量的 set/get 方法?

我们在刚开始学习 Java 语言的时候讲过,面向对象的三大特征就是封装,继承,和多态。在 Java 中,要保证封装性,需要将成员变量私有化,对外提供 set/get 方法来访问,虽然现在的 IDE,像 eclipse,IDEA都提供了快捷键,来生成 set/get 方法,但是在做项目的时候,一个 JavaBean 往往会有很多的成员变量,一个变量对应两个方法,如果有10几个成员变量,那么会对应20多个方法,也许还要去写构造器、equals 等方法,而且需要维护。

这样一来,会使代码变得非常冗余,这些显得很冗长也没有太多技术含量,一旦修改属性,就容易出现忘记修改对应方法的失误。

我在看大佬的项目的源码的时候,看到他们的代码中都没有 set/get 方法,取而代之的是在 JavaBean 上标注的注解,我感到非常的好奇,原来他们是用了一种叫做 Lombok 的插件,便去详细了解了这个插件。

Lombok背景介绍

官方介绍如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code.

大致意思是 Lombok 通过增加一些“处理程序”,可以让 Java 变得简洁、快速。

Lombok使用方法

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

Lombok 的使用跟引用 jar 包一样,可以在官网(https://projectlombok.org/download)下载 jar 包,也可以使用 maven 添加依赖:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<dependency>  
  <groupId>org.projectlombok</groupId>  

    <artifactId>lombok</artifactId>  

    <version>1.18.10</version>  

    <scope>provided</scope>  

</dependency>

注意:

第一次使用 Lombok 插件需要做如下几步配置

  • 将 Lombok 插件安装到 IDEA
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
file -> setting

选中 Plugins,搜索 Lombok,点击 Install

  • 选择默认的编译方式为 javac,因为 eclipse 是不支持 Lombok 的编译方式的,javac 支持 Lombok 的编译方式。
  • 打开注解生成器 Enable annotation processing

再次注意:

IntelliJ IDEA 2019.2(也就是我用的版本)默认是不支持 Lombok 插件的,需要去

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
https://plugins.jetbrains.com/plugin/6317-lombok/versions

下载对应版本的插件,然后手动引入,在 IDEA 中选择 File -> Setting -> plugins 找到 Install Plugin from Disk…(注意版本不同位置可能有所差异)

接下来我们来分析 Lombok 中注解的具体用法

@Data

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

比如我们写一个学生类

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@Data  
public class Student {  

    private String name;  

    private Integer age;  

    private Integer id;  

    private String major;  

}

这样就可以调用 set/get 方法了。

@Getter/@Setter

如果觉得@Data 太过残暴(因为@Data 集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor 的所有特性)不够精细,可以使用@Getter/@Setter 注解,此注解在属性上,可以为相应的属性自动生成 set/get 方法。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public class Student {  
  @Setter private String name;  

    private Integer age;  

    private Integer id;  

    private String major;  

    public static void main(String[] args) {  

        Student stu = new Student();  

        stu.setName("Mr.ml");  

    }  
}

@NonNull

该注解用在属性或构造器上,Lombok 会生成一个非空的声明,可用于校验参数,能帮助避免空指针。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public class Student {  
  @Setter private String name;  

    private Integer age;  

    private Integer id;  

    private String major;  



    public Student(@NonNull String name) {  

        this.name = name;  

    }  

}

@Cleanup

该注解能帮助我们自动调用 close() 方法,很大的简化了代码。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public class CleanupExample {  
  public static void main(String[] args) throws IOException {  

@Cleanup InputStream in = new FileInputStream(args[0]);  

@Cleanup OutputStream out = new FileOutputStream(args[1]);  

byte[] b = new byte[10000];  

while (true) {  

int r = in.read(b);  

      if (r == -1) break;  

      out.write(b, 0, r);  

    }  

  }  

}

@EqualsAndHashCode

默认情况下,会使用所有非静态(non-static)和非瞬态(non-transient)属性来生成 equals 和 hashCode,也能通过 exclude 注解来排除一些属性。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@EqualsAndHashCode(exclude={"id", "shape"})  
public class EqualsAndHashCodeExample {  

    private transient int transientVar = 10;  

    private String name;  

    private double score;  

    private Shape shape = new Square(5, 10);  

    private String[] tags;  

    private int id;  

    public String getName() {  

        return this.name;  

    }  

    @EqualsAndHashCode(callSuper=true)  

    public static class Square extends Shape {  

        private final int width, height;  

        public Square(int width, int height) {  

            this.width = width;  

            this.height = height;  

        }  

    }  

}

@ToString

类使用@ToString 注解,Lombok 会生成一个 toString() 方法,默认情况下,会输出类名、所有属性(会按照属性定义顺序),用逗号来分割。

通过将 includeFieldNames 参数设为 true,就能明确的输出 toString() 属性。这一点是不是有点绕口,通过代码来看会更清晰些。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@ToString(exclude="id")  
public class ToStringExample {  

    private static final int STATIC_VAR = 10;  

    private String name;  

    private Shape shape = new Square(5, 10);  

    private String[] tags;  

    private int id;  

    public String getName() {  

        return this.getName();  

    }  

    @ToString(callSuper=true, includeFieldNames=true)  

    public static class Square extends Shape {  

        private final int width, height;  

        public Square(int width, int height) {  

            this.width = width;  

            this.height = height;  

        }  

    }  

}

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

无参构造器、部分参数构造器、全参构造器。Lombok没法实现多种参数构造器的重载。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@RequiredArgsConstructor(staticName = "of")  
@AllArgsConstructor(access = AccessLevel.PROTECTED)  

public class ConstructorExample<T> {  

    private int x, y;  

    @NonNull private T description;  

    @NoArgsConstructor  

    public static class NoArgsExample {  

        @NonNull private String field;  

    }  

}
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2020-07-29,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 程序员小猿 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
Lombok介绍、使用方法和总结
1 Lombok背景介绍 官方介绍如下: Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code. 大致意思是Lombok通过增加一些“处理程序”,可以让java变得简洁、快速。 2 Lombok使用方法 Lombok能以简单的注解形式来简化java代码,提高开发人员的开发
猿人谷
2018/03/28
1.6K0
Lombok介绍、使用方法和总结
【侠客行】Lombok深度解析
Lombok能以简单的注解形式来简化java代码,提高开发人员的开发效率。例如开发中经常需要写的javabean,都需要花时间去添加相应的getter/setter,也许还要去写构造器、equals等方法,而且需要维护,当属性多时会出现大量的getter/setter方法,这些显得很冗长也没有太多技术含量,一旦修改属性,就容易出现忘记修改对应方法的失误。
大蕉
2019/09/23
6620
【侠客行】Lombok深度解析
Java开发神器Lombok的安装与使用
项目中经常使用bean,entity等类,绝大部分数据类类中都需要get、set、toString、equals和hashCode方法,虽然eclipse和idea开发环境下都有自动生成的快捷方式,但自动生成这些代码后,如果bean中的属性一旦有修改、删除或增加时,需要重新生成或删除get/set等方法,给代码维护增加负担。而使用了lombok则不一样,使用了lombok的注解(@Setter,@Getter,@ToString,@@RequiredArgsConstructor,@EqualsAndHashCode或@Data)之后,就不需要编写或生成get/set等方法,很大程度上减少了代码量,而且减少了代码维护的负担。故强烈建议项目中使用lombok,去掉bean中get、set、toString、equals和hashCode等方法的代码。
秃头哥编程
2019/06/17
5940
Java开发神器Lombok的安装与使用
Java开发的效率工具--Lombok
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库,能自动插入编辑器并构建工具,简化Java开发。通过添加注解的方式,不需要为类编写getter或eques方法,同时可以自动化日志变量。
框架师
2020/07/09
7610
Java开发的效率工具--Lombok
【小家Java】Lombok的使用详解(最详尽的解释,覆盖讲解所有可用注解),解决@Builder.Default默认值问题
Lombok是一款Java开发插件,使得Java开发者可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码,尤其对于简单的Java模型对象(POJO)。在开发环境中使用Lombok插件后,Java开发人员可以节省出重复构建,诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。对于这些方法,它能够在编译源代码期间自动帮我们生成这些方法,并没有如反射那样降低程序的性能。
YourBatman
2019/09/03
3.3K0
【小家Java】Lombok的使用详解(最详尽的解释,覆盖讲解所有可用注解),解决@Builder.Default默认值问题
99%的程序员都在用Lombok,原理竟然这么简单?我也手撸了一个!|建议收藏!!!
  99%的程序员都在用Lombok,原理竟然这么简单?我也手撸了一个!|建议收藏!!!
不会飞的小鸟
2020/03/30
6370
今天 1024,为了不 996,Lombok 用起来以及避坑指南
Lombok 项目是一个 Java 库,它会自动插入编辑器和构建工具中,Lombok 提供了一组有用的注解,用来消除 Java 类中的大量样板代码。
双鬼带单
2020/10/29
8160
最全一篇Lombok使用讲解,及原理,真香啊
Lombok 是一款好用顺手的工具,就像 Google Guava 一样。可用来帮助开发人员消除 Java 的冗长代码,尤其是对于简单的 Java 对象(POJO)。它通过注释实现这一目的。
公众号 IT老哥
2020/09/16
13.2K0
最全一篇Lombok使用讲解,及原理,真香啊
Lombok详解
1. Lombok简介 官网地址:https://projectlombok.org/ Lombok项目是一个Java库,它会自动插入您的编辑器和构建工具中,从而为你优化Java代码。 所以可以不用再手写一个getter、setter或equals方法。 2. 变量使用介绍 2.1 val修饰变量 可以使用val作为局部变量声明的类型,而不用实际编写该类型。 当您执行此操作时,将从初始值设定项表达式中推断出类型。 局部变量也将成为final类型的变量。 此功能仅适用于局部变量和foreach循环,不适用于字
牧晗
2020/06/05
1.3K0
Lombok详解
Eclipse基础安装与简单使用
描述: Eclipse IDE编辑器 它是是由IBM公司开发的一款JAVA程序开发的软件(支持Windows、Mac、Linux),提供了开发的便利性,并且可以免费使用它, 当前版本 Eclipse IDE 2020-12 R;
全栈工程师修炼指南
2022/09/28
6730
Eclipse基础安装与简单使用
Lombok 让代码“亚健康”?你真的用对了吗?
周末的时候,和朋友闲聊,说最近在加班,赶进度,搞项目重构;然后跟我在吐槽,团队不让用Lombok,还列了一堆的缺点说让代码变的"亚健康",本来进度就挺赶的,因为一些基础的代码,消磨着精力和时间,心挺累的...
一行Java
2022/04/07
6370
Lombok 让代码“亚健康”?你真的用对了吗?
lombok使用基础教程
前言 lombok是一个编译级别的插件,它可以在项目编译的时候生成一些代码。在很多工具类的项目中都有这个功能。比如dagger。 通俗的说,lombok可以通过注解来标示生成getter settter等代码。我们自然可以通过编译器比如IDEA的Generate生成,为啥要用这个? 在项目开发阶段,一个class的属性是一直变化的,今天可能增加一个字段,明天可能删除一个字段。每次变化都需要修改对应的模板代码。另外,有的class的字段超级多,多到一眼看不完。如果加上模板代码,更难一眼看出来。更有甚者,由于字
Ryan-Miao
2018/03/14
1.7K0
lombok使用基础教程
Lombok
定位到file/setings/plugins/markeptlace搜索Lombok
框架师
2021/03/08
6440
Lombok
Lombok使用指南
Lombok 是一款 Java 开发插件,使得 Java 开发者可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码,尤其对于简单的 Java 模型对象(POJO)。在开发环境中使用 Lombok 插件后,Java 开发人员可以节省出重复构建,诸如 hashCode 和 equals 这样的方法以及各种业务对象模型的 accessor 和 toString 等方法的大量时间。对于这些方法,Lombok 能够在编译源代码期间自动帮我们生成这些方法,但并不会像反射那样降低程序的性能。
一个正经的程序员
2022/04/11
1.2K0
Lombok使用指南
优雅的JAVA工具库LOMBOK
最近在公司的项目中看到了对于Lombok的应用,通过@Data注解标注POJO,省略了大量的getter/setter代码,原先冗长的POJO在瘦身之后直接变得干净、清爽,程序员再也不需要去关注那些长长的方法,只需要集中注意力于字段field之中
java架构师
2019/01/03
5590
Java 之 Lombok 必知必会
在目前众多编程语言中,Java 语言的表现还是抢眼,不论是企业级服务端开发,还是 Andorid 客户端开发,都是作为开发语言的首选,甚至在大数据开发领域,Java 语言也能占有一席之地,如 Hadoop,Spark,Flink 大数据等。而作为已经诞生 24 年的 Java 相比其他语言来说,编写起来略显得冗长和复杂,而为了能极大提升 Java 开发的效率和代码简洁性,一个 Java 库 Lombok 就这样诞生了。
闻人的技术博客
2019/09/19
9350
Java 之 Lombok 必知必会
超级全面的 Lombok 注解介绍,学一波!
blog.csdn.net/riemann_/article/details/105374987
全栈程序员站长
2021/06/29
5.2K0
lombok在java项目中的使用
@NoArgsConstructor@RequiredArgsConstructor@AllArgsConstructor
jinjunzhu
2020/08/20
6900
Java效率工具Lombok使用及原理
在过往的Java项目中,充斥着太多不友好的代码:POJO的getter/setter/toString;异常处理;I/O流的关闭操作等等,这些样板代码既没有技术含量,又影响着代码的美观,Lombok应运而生。
Bug开发工程师
2019/05/05
5900
Java效率工具Lombok使用及原理
简化开发|Lombok神器带你消除冗余代码
Lombok是一款Java开发插件,使得Java开发者可以通过其定义的一些注解来消除业务过程中冗余的代码,尤其是简单的Java模型对象(POJO)。而当我们如果在开发环境中使用Lombok开发插件后,可以省出重复构建,诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。对于这些方法,它能够在编译源代码期间自动帮我们生产这些方法,并没有如反射那样降低程序的性能。本文将带大家详细介绍关于Lombok的使用以及原理。
浅羽技术
2020/12/07
5610
简化开发|Lombok神器带你消除冗余代码
相关推荐
Lombok介绍、使用方法和总结
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验