Java注解详解

程序员杨叔

已于 2022-10-16 10:34:50 修改

阅读量8.1k

点赞数 11

分类专栏： Java 测试平台开发文章标签： java spring 软件测试

于 2022-10-13 19:23:48 首次发布

本文链接：https://blog.csdn.net/baidu_28340727/article/details/127160837

版权

测试平台开发同时被 2 个专栏收录

20 篇文章 0 订阅

订阅专栏

Java

13 篇文章 4 订阅

订阅专栏

一、发现注解

在看项目代码的时候，经常会看到@XXXX这样的写法，有的有参数、有的没有参数：

在这里插入图片描述

其实这些都是注解，本文主要介绍什么是注解，为什么用注解，以及Java中常用的一些注解，希望能帮助大家理解和使用注解。如果对你有帮助，欢迎关注我的vx公众号：程序员杨叔，各类文章都会第一时间在上面发布，持续分享全栈测试知识干货，你的支持就是作者更新最大的动力~

二、注解是什么

1. 注解的本质

java.lang.annotation.Annotation 接口中有这么一句话，用来描述『注解』：

The common interface extended by all annotation types
所有的注解类型都继承自这个普通的接口（Annotation）

这句话有点抽象，但却说出了注解的本质。我们看一个 JDK 内置注解的定义：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

这是注解 @Override 的定义，其实它本质上就是：

public interface Override extends Annotation{    
}

注解的本质就是一个继承了 Annotation（注解）接口的接口。

2. 注解是针对Java编译器的说明

注解，Annotation是JDK5.0引入的新技术。
注解的格式：@注释名，还可以添加参数（必要时）
注解不是程序本身，但可以对程序作出解释（就这一点，注释和注解的作用类似）
注解可以被其他程序读取（比如编译器等等）
注解可以给Java包、类型(类、接口、枚举)、构造器、方法、域、参数和局部变量进行注解，相当于给它们添加了一些额外的辅助信息。Java编译器可以根据指令来解释注解和放弃注解，或者将注解放到编译后的生成的class文件中，运行时可用。通过反射机制编程实现对这些元数据的访问。

一个注解准确意义上来说，只不过是一种特殊的注释而已，如果没有解析它的代码，它可能连注释都不如。注解只是元数据，不包含任何业务逻辑。

三、为什么要使用注解

1、检查
2、约束
3、灵活
4、方便简洁
5、让静态语言拥有动态机制

注解和XML的异同：

『XML』是各大框架的青睐者，它以松耦合的方式完成了框架中几乎所有的配置，但是随着项目越来越庞大，『XML』的内容也越来越复杂，维护成本变高。

于是就有人提出来一种标记式高耦合的配置方式，『注解』。方法上可以进行注解，类上也可以注解，字段属性上也可以注解，反正几乎需要配置的地方都可以进行注解。

关于『注解』和『XML』两种不同的配置模式，争论了好多年了，各有各的优劣，注解可以提供更大的便捷性，易于维护修改，但耦合度高，而 XML 相对于注解则是相反的。

追求低耦合就要抛弃高效率，追求效率必然会遇到耦合。现在的项目更多的是结合使用，各取所长。

四、Java中常用的注解

4.1 基础注解（spring-context、spring-web包）

1. @Controller、@Service、 @Repository、 @Configuration

用于标注各个层级的注解，注入到spring容器管理：

@Controller 标注于控制层
@Service 标注于业务层
@Repository 标注于dao持久层
@Configuration 标注于配置层

示例：

@Controller
@RequestMapping(value = "/api/user")
public class UserController {
}

2. @Bean

@Bean是一个方法级别上的注解，主要用在@Configuration注解的类里，也可以用在@Component注解的类里。Spring的@Bean注解用于告诉方法，产生一个Bean对象，然后这个Bean对象交给Spring管理。

示例：
在src根目录下创建一个AppConfig的配置类，这个配置类也就是管理一个或多个bean 的配置类，并在其内部声明一个userService的bean

@Configuration
public class AppConfig {
    @Bean
    public UserService userService(AccountRepository accountRepository) {
        return new UserServiceImpl(accountRepository);
    }
}

这个配置就等同于之前在xml里的配置：
@Configuration可理解为用spring的时候xml里面的< beans >标签
@Bean可理解为用spring的时候xml里面的< bean >标签

<beans>
    <bean id="userService" class="com.test.UserServiceImpl"  depends-on="accountRepository"/>
</beans>

3. @ResponseBody、@RequestMapping、@RequestBody

@ResponseBody：
该方法的返回的结果直接写入 HTTP 响应正文（ResponseBody）中。

@RequestMapping：
该方法用来处理请求地址映射的注解。

@RequestBody：
用于接收前端请求的Json参数，并且封装到对应的JavaBean。

示例：

@Controller
public class UserContorller{
	@Autowired
	private UserService userService;
	
	@ResponseBody
	@RequestMapping(value = "userLogin", method = RequestMethod.POST)
	// 将前端ajax发出的请求写入User对象中
	public String login(@RequestBody User user) {   
	    return userService.getLogin(user);    
	}
}

4.2 Java内置的3大注解（java.lang下的）

1. @Override

帮助检查是否正确的复写了父类中已有的方法。告诉读代码的人，这是一个复写的方法。

示例：

public class UserServicesImpl implements UserServices {
    
    @Autowired
    private UserDao userDao;

    @Override
    public User register(String name, Integer age, String pwd){
    	......
    }

2. @Deprecated

标记当前的类或者方法或者字段等已经不再被推荐使用了，可能下一次的 JDK 版本就会删除，调用时也会出现删除线，但并不代表不能用。在新版本中有其他方法或类可以代替这个使用，以后的版本也不会再更新这个方法或类。

示例：

     /**
     * 请改用每个实体对象的实例方法的existed()方法。
     */
    @Deprecated
    public static <T extends Entity> boolean exists(Class<T> clazz, Serializable id) {
        return getRepository().exists(clazz, id);
    }

3. @SuppressWarnings

主要用来抑制 java 的警告。它有一个 value 属性需要你主动的传值，这个 value 代表的就是需要被压制的警告类型。例如：

public static void main(String[] args) {
    Date date = new Date(2018, 7, 11);
}

这么一段代码，程序启动时编译器会报一个警告：

Warning:(8, 21) java: java.util.Date 中的 Date(int,int,int) 已过时

而如果我们不希望程序启动时，编译器检查代码中过时的方法，就可以使用 @SuppressWarnings 注解并给它的 value 属性传入一个参数值来压制编译器的检查。

@SuppressWarning(value = "deprecated")
public static void main(String[] args) {
    Date date = new Date(2018, 7, 11);
}

这样会发现，编译器不再检查 main 方法下是否有过时的方法调用，也就压制了编译器对于这种警告的检查。

JAVA 中还有很多的警告类型，他们都会对应一个字符串，通过设置 value 属性的值即可压制对于这一类警告类型的检查。

4.3 lombok常用注解

1. @Slf4j和@Log

Maven依赖：

<dependency>
	   <groupId>org.projectlombok</groupId>
	   <artifactId>lombok</artifactId>
	   <version>1.16.12</version>
	   <scope>provided</scope>
</dependency>

@Slf4j：注解在类上,为类提供一个属性名为 log 的 log4j 的日志对象，避免重复代码。
@Log：使用的是 java.util.logging.Logger ，直接使用变量 log，用法同上。

示例：

@Service
@Slf4j
public class UserServicesImpl implements UserServices {
	@Override
    public User login(String name, String pwd){
    	log.info("用户名："+name, "密码："+pwd);
    }
}

2. @Data

用在pojo类，在类上面加这个注解。简化java代码编写，为该类提供读写属性，无需再写set和get方法。

示例：

@Data
public class User {
    //映射数据库字段
    private Long id;
    private String name;
    private Integer age;
    private String pwd;
    //定义一个msg，发送消息
    private String msg;
}

4.4 Springboot常用注解

1. @Component、@ConfigurationProperties、@Value

@Component：
实现bean的注入，当类不属于各种归类的时候（不属于@Controller、@Services等的时候），就可以使用@Component来标注这个类。

@ConfigurationProperties：
批量注入.properties配置文件中的属性，prefix的值是properties文件中属性的前缀。

@Value：
单个注入.properties配置文件中的属性。

配置文件内容：

spring.datasource.url=jdbc:mysql://127.0.0.1:8888/test?useUnicode=false&autoReconnect=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

Java类-@ConfigurationProperties写法：

@Component
@Data
@ConfigurationProperties(prefix = "spring.datasource")
public class DataBaseConfig {

    public String url;
    public String username;
    public String password;
    // 配置文件中是driver-class-name, 转驼峰命名便可以绑定成
    public String driverClassName;
    public String type;
}

Java类-@Value写法：

@Component
@Data
public class DataBaseConfig {
	
	@Value("${spring.datasource.url}")
    public String url;
    @Value("${spring.datasource.username}")
    public String username;
    @Value("${spring.datasource.password}")
    public String password;
    // 配置文件中是driver-class-name, 转驼峰命名便可以绑定成
    @Value("${spring.datasource.driver-class-name}")
    public String driverClassName;
    @Value("${spring.datasource.type}")
    public String type;
}

用法：

@Controller
@RequestMapping(value = "/config")
public class ConfigurationPropertiesController {

    @Autowired
    private DataBaseConfig dataBaseConfig ;

    @RequestMapping("/test")
    @ResponseBody
    public Map<String, Object> test(){

        Map<String, Object> map = new HashMap<>();
        map.put("url", dataBaseConfig.url);
        map.put("userName", dataBaseConfig.username);
        map.put("password", dataBaseConfig.password);
        map.put("className", dataBaseConfig.driverClassName);
        map.put("type", dataBaseConfig.type);

        return map;
    }
}

2. @Mapper和@MapperScan（Mybatis注解）

在使用Mybatis持久层框架来操作数据库时，使用@Mapper注解和@MapperScan注解来将Mapper接口类交给Sprinig进行管理，能够让其他类进行引用。

@Mapper：
在dao接口类中，添加此注解。麻烦点在于每个dao接口类都必须添加此注解；

示例：

@Repository
@Mapper
public interface UserDao {
}

@MapperScan：
可以指定要扫描的dao接口类的包路径，可以在启动类中添加此注解，可替代@Mapper注解（此包下的dao接口类不用再添加@Mapper注解）

示例：

@SpringBootApplication 
@MapperScan("com.test.dao")  
public class TestDemoApplication{  
    public static void main(String[] args) {  
       SpringApplication.run(TestDemoApplication.class, args);  
    }  
}

3. @SpringBootApplication

@SpringBootApplication的作用等价于同时组合使用@EnableAutoConfiguration，@ComponentScan，@SpringBootConfiguration，是这三个注解的复合注解。每次写三个会显得极其麻烦，将其整合。

Springboot是通过注解@EnableAutoConfiguration的方式，去查找、过滤、加载所需的配置文件，@ComponentScan扫描我们自定义的bean，@SpringBootConfiguration使得被@SpringBootApplication注解的类声明为注解类。

@SpringBootApplication默认扫描主程序所在的包以及所有子包内的组件。如果需要改变扫描路径，带上参数scanBasePackages则会扫描指定路径。

示例：

@SpringBootApplication(scanBasePackages={"com.test"})
public class TestDemoApplication{  
    public static void main(String[] args) {  
       SpringApplication.run(TestDemoApplication.class, args);  
    }  
}

4. @Autowired、@Resource

注入bean的两个注解，其中：

@Autowired是Spring自带的
@Resource是JSR250规范的实现，需要导入javax.annotation实现注入

在Spring框架中，如果在Service层中需要注入其他依赖的对象，通常我们都会使用@Autowired或者@Resource注解，两者使用上没有太大区别。

只是@Autowired跟Spring框架强耦合了，如果换成其他框架，@Autowired就没作用了。而@Resource是JSR-250提供的，它是Java标准，绝大部分框架都支持。

示例：

    @Autowired
    private UserDao userDao;

	//默认需要配置与变量名一致，一般会指定一个name属性
    @Resource(name = "userDao")
    private UserDao userDao;

================================================================================================
以上就是本次的全部内容，都看到这里了，如果对你有帮助，麻烦点个赞+收藏+关注，一键三连啦~

欢迎关注我的vx公众号：程序员杨叔，各类文章都会第一时间在上面发布，持续分享全栈测试知识干货，你的支持就是作者更新最大的动力~

程序员杨叔：持续分享全栈测试知识干货。标签：自动化测试、性能测试、Java、Python、DevOps、CI/CD、小程序测试、测试工具、测试开发、测试框架/平台、测试管理…