栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

让代码更优雅 - lombok

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

让代码更优雅 - lombok

lombok 使用 1. 为什么使用lombok

在过往的Java项目中,充斥着太多不友好的代码:POJO的getter/setter/toString;异常处理;I/O流的关闭操作等等,这些样板代码既没有技术含量,又影响着代码的美观在这样的背景下,Lombok应运而生。lombok能够达到的效果就是在源码中不需要写一些通用的方法,但是在编译生成的字节码文件中会帮我们生成这些方法,减少代码冗余

2.安装 2.1 添加依赖包
 
       org.projectlombok
       lombok
       1.18.6
   
2.2 安装插件 2.2.1 idea安装


下载完成重启idea即可

2.2.2 eclipse安装

下载jar包:链接: lombok
使用java -jar 命令运行jar包:java -jar D:softwarelombok.jar D:softwarelombok.jar这是windows下lombok.jar所在的位置

数秒后将弹出一框,以确认eclipse的安装路径

安装:确认完eclipse的安装路径后,点击install/update按钮,即可安装完成
确认:安装完成之后,请确认eclipse安装路径下是否多了一个lombok.jar包,并且在eclipse.ini中是否 添加了如下内容

-javaagent:lombok.jar
-Xbootclasspath/a:lombok.jar

如果没有可以手动添加,最后 重启eclipse

3.使用

@Data:使用在类上可以根据当前类所定义的属性来生成相应的setter、getter、toString()、equals()、hashCode()方法
@NonNull:使用在属性上,被标注的属性值不可以为空。查看此.class字节码文件后发现会生成一个有参构造,构造器的参数是带有@NonNull注解的属性,由于已经生成有参构造便不再会生成无参构造器
@RequiredArgsConstructor(推荐使用):写在类上可以代替@Autowired注解,需要注意的是在注入时需要用final定义,或者使用@notnull注解,其核心是生成有参构造器,参数为final或者@notnull标注的属性

@RestController
@RequiredArgsConstructor
@RequestMapping("/user")
@Api(value = "user", tags = "用户管理模块")
public class SysUserController {

	private final SysUserService userService;
}

@AllArgsConstructor: 添加在类上,核心是生成全参构造器,代替@Autowired使用,如下所示

@Slf4j
@Configuration
@AllArgsConstructor
public class RouterFunctionConfiguration {
    private final HystrixFallbackHandler hystrixFallbackHandler;
    private final ImageCodeHandler imageCodeHandler;
    
}

// 替代如下代码

@Slf4j
@Configuration
public class RouterFunctionConfiguration {
    @Autowired
    private  HystrixFallbackHandler hystrixFallbackHandler;
    @Autowired
    private  ImageCodeHandler imageCodeHandler;
}

@SneakyThrows:抛出异常,核心是编译后生成try-catch代码块

@SneakyThrows
private void checkCode(ServerHttpRequest request) {
    String code = request.getQueryParams().getFirst("code");
    
    if (StrUtil.isBlank(code)) {
        throw new ValidateCodeException("验证码不能为空");
    }
    
    redisTemplate.delete(key);
}


// 不使用就要加这个抛出
private void checkCode(ServerHttpRequest request) throws ValidateCodeException {
    String code = request.getQueryParams().getFirst("code");
    
    if (StrUtil.isBlank(code)) {
        throw new ValidateCodeException("验证码不能为空");
    }
}

@UtilityClass:添加在类上,将类中所有方法变成静态static方法,推荐使用在工具类中,不用定义static的方法了,直接就可以Class.Method 使用

@UtilityClass
public class Utility {
    
    public String getName() {
        return "name";
    }
}

public static void main(String[] args) {
    System.out.println(Utility.getName());
}

@Cleanup:清理流对象,不用手动去关闭流,核心是编译后生成try-finally代码块并在finally中关闭资源。多!么!优!雅!

@Cleanup
OutputStream outStream = new FileOutputStream(new File("text.txt"));
@Cleanup
InputStream inStream = new FileInputStream(new File("text2.txt"));
byte[] b = new byte[65536];
while (true) {
    int r = inStream.read(b);
    if (r == -1) break;
    outStream.write(b, 0, r); 
}

@NoArgsConstructor:生成一个无参构造器
@Value:作用于类,使所有的成员变量都是 final 注意:使用该注解时千万不要导错包,该注解和spring中的撞名了
@Synchronized(不推荐使用):注解声明在方法上可以自动生成synchronized代码块,synchronized代码块锁定的同步对象是lombok自动生成的Object数组。虽然他也很优雅但是不推荐使用,会有死锁隐患,使用时请慎重

4.总结

lombok常用的注解大概就是这些,推荐在你以后的工程中使用,减少那些冗余的代码

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/975236.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号