Spring中常用注解及其作用

原创已于 2023-02-07 20:17:55 修改

· 1.7w 阅读

306 ·

版权

文章标签：

#spring

于 2020-09-02 17:30:56 首次发布

Spring 专栏收录该内容

4 篇文章

订阅专栏

1.@Component

它是这些注解里面最普通的一个注解，一般用于把普通pojo实例化到spring容器中。
@Controller和@Service和@Repository是它的特殊情况，当一个类不需要进行这几种特殊归类的时候，只是作为一个普通的类，被Spring管理就OK的时候，比较适合采用@Component注解。
原理：将普通JavaBean实例化到spring容器中,Spring容器统一管理，用起来不用自己new了，相当于配置文件中的< bean id=“” class=“”/>

2.@Controller

用于标注控制层，表示向控制层注入服务层的数据

3.@Service

用于标注服务层，来进行业务的逻辑处理，在服务层注入DAO层数据

4.@Repository

用于标注数据访问层，也可以说用于标注数据访问组件，即DAO组件

5.@ComponentScan

（这个注解长得和@Component有点像，但是他们是完全两个不同类型的注解，@Component像一个标签，标志着你这类是个啥，而@ComponentScan像一个路标，告诉你去哪找东西）

应用场景：在定义spring中的bean的时候，一般有两步
1.在bean上面添加@Controller/@Service/@Repository/@Component这几个注解，标注这个类是个bean
2.然后还需要让Spring能够找到这个bean，这时候就需要使用到@ComponentScan这个注解了

使用：@ComponentScan(“com.demo”) 引号里面是要扫描的包路径

SpringBoot中的使用：
在SpringBoot中也许不会经常看到这个注解，因为@SpringBootApplication这个注解里面集成了@ComponentScan注解，它里面会自动扫描这个类所在包以及子包下面的bean。
所以如果我们要找的bean不在它的所在包或者子包里面，就需要自己再添加一个@ComponentScan注解。例如：
@ComponentScan({“com.demo.springboot”,”com.demo.somethingelse”})

6.@ResponseBody

加了这个注解的类会将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML。
在这里插入图片描述
需要注意的是，在使用此注解之后的数据不会再走ViewResolver，而是直接将数据写入到输入流中，它的效果相当于用response对象输出指定格式的数据。

当它返回json串的时候，效果相当于：

response.getWriter.write(JSONObject.fromObject(对象).toString());

7.@RestController

@RestController = @Controller + @ResponseBody

写这一个注解就相当于写了后面的两个注解，在返回值是json串的非常方便，但同时也会有一个问题，加了这个注解就不能返回jsp或者html页面，这时可以通过返回视图数据的方式来返回页面。
例如：

	ModelAndView mv = new ModelAndView("index")； 
	return mv;

8.@RequestMapping(“xxxx”)

它用于 映射客户端的访问地址，可以被应用于类和方法上面，客户进行访问时，URL应该为类+方法上面的这个注解里面的内容。
例如：
下面这个类里面方法的访问地址就应该是：http://localhost:8080/AB

@Controller
@RequestMapping("/A")
public class HelloWorld{
	
	@RequestMapping("/B")
	public String helloworld(){
	}
}

格式：@RequestMapping(" ") 双引号里面默认是value的值，
所以@RequestMapping(value = “a”)等价于@RequestMapping(“a”)
除了value之外，@RequestMapping里面还有这些属性
里面经常用的有mehod,params,headers
分别为请求方法，请求参数，请求头。
它们之间是与的关系，联合使用会使得请求的映射更加精细

method：可以指定请求的类型。
http中规定请求有四种类型：get，post，put，delete。
例如：下面这种情况中，只有DELETE方式的helloworld请求才能够执行该处理方法。
```
@RequestMapping(value="/helloworld", method=RequestMethod.DELETE) 
public class helloworld{   }
```
1. params和headers支持简单的表达式：
  params1：表示请求必须包含名为params1的请求参数
  !params1：表示请求不能包含名为params1的请求参数
  params1 != value1：表示请求必须包含名为params1的请求参数，但是其值不能是value1
  {“params1 = value1”, “param2”}：表示请求必须包含名为params1和params2两个请求参数，且params1的值必须为value1

5.三种Ant风格的URL
/user/create?? 匹配/user/createAA、/user/createBB等URL （??匹配任意两个字符）
user/*/createUser 匹配/user/aaa/createUser、/user/bbb/createUser等URL （*匹配任意字符）
/user/**/createUser 匹配/user/createUser、/user/aaa/bbb/createUser等URL （**匹配任意多层路径）

6.RestFul风格的URL
使用 @PathVariable 获取到URL的{ }中参数
例如：

@RequestMapping("/delete/{id}")
public String testPathVariable(@PathVariable("id") Integer id){
    System.out.println("id = " + id);
        
    return SUCCESS;
}

9.@AutoWired

这个注解的英文直译是“自动装配”，“自动注入”

它就像一根水管一样，两端接上水桶，然后就可以把一个桶里面的水自动注入到另一个桶中。

这两端的桶，可以是 类成员变量/方法/构造函数

中间流的水，可以是 数组/集合/Map/父类属性

一般使用场景：

@Service
 public class UserService {
 
     @Autowired
     //定义一个变量来接收注入过来的类
     private UserRepository userRepository;
    
     public void save(){
     //然后就可以通过点来调用这个类里面的方法
         userRepository.save();
     }
 }

注意事项：

@Autowired是ByType的，在使用时首先在容器中查询对应类型的bean

如果查询结果刚好为一个，就将该bean装配给@Autowired指定的数据

如果查询的结果不止一个，那么@Autowired会根据名称来查找（首字母小写）。

如果查询的结果为空，那么会抛出异常。解决方法是，@AutoWired(required=false)

@AutoWired加在变量/方法上面与加在构造器上面有什么区别？

答：加在构造器上面更保险一些。

因为Java变量的初始化顺序为：
静态变量或静态语句块–>实例变量或初始化语句块–>构造方法–>@Autowired

如果在加在变量/方法上面，那么下面这段代码就会报错

@Autowired
private User user;
private String school;

public UserAccountServiceImpl(){
    this.school = user.getSchool();
}

因为先会执行构造方法，而这个时候还没有注入，所以get不出来，会报空指针错误。

相反，如果加在构造器上面就不会报错。如下：

private User user;
private String school;

@Autowired
public UserAccountServiceImpl(User user){
    this.user = user;
    this.school = user.getSchool();
}

10.Qualifer

这个注解是用来辅助@AutoWired注解来使用的。
用于当@AutoWired在注入父类属性时有两个或以上实现类时，指定要用哪个。

👆上面在@AutoWired注解里面说了，当实现类有多个的时候，它会自动去找和它名称相同的实现类（首字母小写），但如果我们不想这样，就可以加一个@Qualifer注解来指定具体要注入哪一个实现类。

举例如下⬇️：


//父级接口
public interface IMenuService {
	/**
	 * 获取所有菜单列表
	 * 
	 * @return List<MenuEntity>
	 */
	public List<MenuEntity> getAllMenuList();
}

//实现类1
@Service("menuService1")
public class MenuServiceImpl implements IMenuService {
	@Autowired
	private MenuMapper mapper;
	/**
	 * 获取所有菜单
	 */
	@Override
	public List<MenuEntity> getAllMenuList() {
			MenuEntityExample example = new MenuEntityExample();
			long start = System.currentTimeMillis();
			example.setDistinct(false);
			List<MenuEntity> allMneuList = mapper.selectByExample(example);
	}


//实现类2
@Service("menuService2")
public class MenuServiceImpl implements IMenuService {
	/**
	 * 获取所有菜单
	 */
	@Override
	public List<MenuEntity> getAllMenuList() {
			return null;
	}

现在如果想要注入实现类1的话，应该这样⬇️

 	@Autowired
    @Qualifier("menuService1")
    private IMenuService menuService;

想要注入实现类2的话，应该这样⬇️

@Autowired
    @Qualifier("menuService2")
    private IMenuService menuService;

11.@Resource

这个注解的作用和@AutoWired一致，
只不过@AutoWired是ByType的，而@Resource是ByName的
@AutoWired首先按类型查找，同类型的有多个时，才按照首字母小写来匹配
@Resource首先按照名称查找，没有对应名称时，才按照类型匹配