架构

发布日期: 2022-06-08

文章字数: 1.5k

阅读时长: 6 分

阅读次数:

目录：

简介

实现原理

安装Lombock插件

与Springboot整合

参考/来源：

https://mp.weixin.qq.com/s/h8C1AoOUMYKGp8E1DfLBbg

简介

lombok是一个可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具。

简单来说，比如我们新建了一个类，然后在其中写了几个字段，然后通常情况下我们需要手动去建立getter和setter方法啊，构造函数啊之类的，lombok的作用就是为了省去我们手动创建这些代码的麻烦，它能够在我们编译源码的时候自动帮我们生成这些方法。

 @Data
 public class TestLombok {
     private String name;
     private Integer age;
 
     public static void main(String[] args) {
         TestLombok testLombok = new TestLombok();
         testLombok.setAge(12);
         testLombok.setName("zs");
    }
}

实现原理

编译时注解

正常情况下我们在项目中自定义注解，或者使用Spring框架中@Controller、@Service等等这类注解都是运行时注解，运行时注解大部分都是通过反射来实现的。而Lombok是使用编译时注解实现的。

Java中的注解分为运行时注解和编译时注解，运行时注解就是我们经常使用的在程序运行时通过反射得到我们注解的信息，然后再做一些操作。而编译时注解是什么呢？就是在程序在编译期间通过注解处理器进行处理。

编译期：Java语言的编译期是一段不确定的操作过程，因为它可能是将*.java文件转化成*.class文件的过程；也可能是指将字节码转变成机器码的过程；还可能是直接将*.java编译成本地机器代码的过程
运行期：从JVM加载字节码文件到内存中，到最后使用完毕以后卸载的过程都属于运行期的范畴。

apt

注解处理工具apt(Annotation Processing Tool)，这是Sun为了帮助注解的处理过程而提供的工具，apt被设计为操作Java源文件，而不是编译后的类。

它是javac的一个工具，中文意思为编译时注解处理器。APT可以用来在编译时扫描和处理注解。通过APT可以获取到注解和被注解对象的相关信息，在拿到这些信息后我们可以根据需求来自动的生成一些代码，省去了手动编写。Lombok是修改了Java中的抽象语法树AST才做到了修改其原有类的信息。

注意：获取注解及生成代码都是在代码编译时候完成的，相比反射在运行时处理注解大大提高了程序性能。APT的核心是AbstractProcessor类。

 @SupportedSourceVersion(SourceVersion.RELEASE_8)
 @SupportedAnnotationTypes("aboutjava.annotion.MyGetter")
 public class MyGetterProcessor extends AbstractProcessor 
   
   /**
   主要是获得编译时期的一些环境信息
   */
     @Override
     public synchronized void init(ProcessingEnvironment processingEnv) {
     super.init(processingEnv);
     }
 		
		/**
		在编译时，编译器执行的方法。也就是我们写具体逻辑的地方
		*/
     @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return true;
    }
}

安装Lombok插件

下载lombok.jar包https://projectlombok.org/download.html
运行Lombok.jar: java -jar D:\software\lombok.jar。D:\software\lombok.jar这是windows下lombok.jar所在的位置。数秒后将弹出一框，以确认eclipse的安装路径。
确认完eclipse的安装路径后，点击install/update按钮，即可安装完成
安装完成之后，请确认eclipse安装路径下是否多了一个lombok.jar包，并且其配置文件eclipse.ini中是否添加了如下内容:
```
-javaagent:lombok.jar
-Xbootclasspath/a:lombok.jar
```
那么恭喜你已经安装成功，否则将缺少的部分添加到相应的位置即可，重启eclipse或myeclipse。

与Springboot整合

maven依赖

<!--Lombok -->
<dependency>
     <groupId>org.projectlombok</groupId>
     <artifactId>lombok</artifactId>
     <version>1.18.6</version>
</dependency>
<dependency>
     <groupId>net.logstash.logback</groupId>
     <artifactId>logstash-logback-encoder</artifactId>
     <version>4.9</version>
</dependency>

日志配置文件

文件名：logback.xml

位置：放到resource文件夹下

<?xml version="1.0" encoding="UTF-8"?>
<configuration>    
	<!-- 项目名称 -->
	<property name="projectname" value="XXX" />    
	<!-- 日志存放路径 -->
	<property name="log.path" value="./logs/" />    
	<!-- 日志输出格式 -->
	<property name="log.pattern"
		value="%d{yyy-MM-dd HH:mm:ss.SSS} [%X{X-B3-TraceId:-},%X{X-B3-SpanId:-}] [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />   
	<!-- 控制台输出 -->
	<appender name="console"
		class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
	</appender>      
	<!-- 系统日志输出 -->
	<appender name="file_info"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${log.path}/${projectname}-info.log</file>        
		<!-- 循环政策：基于时间创建日志文件 -->
		<rollingPolicy
			class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            
			<!-- 日志文件名格式 -->
			<fileNamePattern>${log.path}/${projectname}-info.%d{yyyy-MM-dd}.log
			</fileNamePattern>         
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</maxHistory>
		</rollingPolicy>
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
		<filter class="ch.qos.logback.classic.filter.LevelFilter">            
			<!-- 过滤的级别 -->
			<level>INFO</level>            
			<!-- 匹配时的操作：接收（记录） -->
			<onMatch>ACCEPT</onMatch>            
			<!-- 不匹配时的操作：拒绝（不记录） -->
			<onMismatch>DENY</onMismatch>
		</filter>
	</appender>
	<appender name="file_error"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${log.path}/${projectname}-error.log</file>        
		<!-- 循环政策：基于时间创建日志文件 -->
		<rollingPolicy
			class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            
			<!-- 日志文件名格式 -->
			<fileNamePattern>${log.path}/${projectname}-error.%d{yyyy-MM-dd}.log
			</fileNamePattern>         
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</maxHistory>
		</rollingPolicy>
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
		<filter class="ch.qos.logback.classic.filter.LevelFilter">           
			 <!-- 过滤的级别 -->
			<level>ERROR</level>         
			<!-- 匹配时的操作：接收（记录） -->
			<onMatch>ACCEPT</onMatch>         
			<!-- 不匹配时的操作：拒绝（不记录） -->
			<onMismatch>DENY</onMismatch>
		</filter>
	</appender>      
	<!-- 系统模块日志级别控制 -->
	<logger name="com.loop" level="info" />   
	<!-- Spring日志级别控制 -->
	<logger name="org.springframework" level="warn" />
	<root level="info">
		<appender-ref ref="console" />
	</root>      
	<!--系统操作日志 -->
	<root level="info">
		<appender-ref ref="file_info" />
		<appender-ref ref="file_error" />
	</root>
</configuration>