提高编码效率-Lombok

在实际的编码过程中，想必大家都写过很多机械的固定化的代码（如POJO的getter/setter/toString/构造器；异常处理；I/O流的关闭；日志打印等等），这些代码的编码既耗费程序员的精力，又影响代码的美观跟简介。

为了解决上述问题，lombok应运而生

lombok的使用也很简单，使用方法如下：

一、引入pom依赖

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${projectlombok.version}</version>
</dependency>

二、添加IDE工具对Lombok的支持

三、Lombok实现原理

自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中，它产生作用的具体流程如下：

javac对源代码进行分析，生成一棵抽象语法树(AST)
javac编译过程中调用实现了JSR 269的Lombok程序
此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点
javac使用修改后的抽象语法树(AST)生成字节码文件

四、常用Lombok注解的使用

1)、 @Data、@AllArgsConstructor、@NoArgsConstructor

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User{

    
    private String userName;

}

如上代码，@Data会自动生成get/set方法，@AllArgsConstructor会生成全参构造器，@NoArgsConstructor会生成无参构造器

推荐理由：当你改变属性名时，不用重新生成get/set方法及构造器，简化代码

2）、@SneakyThrows 异常抛出


@RestController
@RequestMapping("/config/v1")
public class BaseConfigController {

    @Autowired
    private BaseConfigService baseConfigService;

    @SneakyThrows(Exception.class)
    @PostMapping(value = "/getAppVersion")
    public BaseResponse<QueryAppUpdateResponse> checkApiVersion(@ModelAttribute @Valid QueryAppUpdateApiRequest versionRequest, BindingResult bindingResult) {
        ParamVerifyUtils.verifyParams(bindingResult);
        return baseConfigService.checkAppVersion(versionRequest);
    }

}

如上代码，使用@SneakyThrows相当于抛出了异常，编译之后，代码变成了


@RestController
@RequestMapping("/config/v1")
public class BaseConfigController {

    @Autowired
    private BaseConfigService baseConfigService;

    @PostMapping(value = "/getAppVersion")
    public BaseResponse<QueryAppUpdateResponse> checkApiVersion(@ModelAttribute @Valid QueryAppUpdateApiRequest versionRequest, BindingResult bindingResult) throws Exception {
        ParamVerifyUtils.verifyParams(bindingResult);
        return baseConfigService.checkAppVersion(versionRequest);
    }

}

3）日志打印 @Slf4j

@Slf4j
@Service
public class BaseConfigServiceImpl implements BaseConfigService {


    @Autowired
    private ServiceConfig serviceConfig;

    @Override
    public BaseResponse<QueryAppUpdateResponse> checkAppVersion(QueryAppUpdateApiRequest request) {
        log.info("日志输出:{}",request);
    }
}

通过上面代码，可以简化log对象的声明，省略如下代码了

private static final Logger log = LoggerFactory.getLogger(BaseConfigServiceImpl.class);

4)、自动关闭资源 @Cleanup

适用场景：针对实现了java.io.Closeable接口的对象有效，如IO流对象

5)、@Synchronized：作用于方法级别，可以替换synchronize关键字或lock锁。

以上为本人在实际项目中经常用到的注解，如果大家有比较好用的其他注解，麻烦推荐一下。

提高编码效率-Lombok

猜你喜欢