六、Spring 中注解的使用及区别

@Configuration ， @ComponentScan，
@Component，@Controller，@Service，@Repository，@RestController，
@Bean，@Scope，
@Autowired，@Resource，
@Qualifier，
@PostConstruct，@PreDestory，
@RequestMapping，@GetMapping，@PostMapping，@PutMapping，@DeleteMapping，@PatchMapping，
@RequestBody，@Validated，@Valid，@RequestParam，@PathVariable，
@ModelAttribute

@Configuration 作用于类上

作用：用 @Configuration 标注的类就相当于 xml 中的
注意：

@Configuration 不可以是final类型；
@Configuration 不可以是匿名类；
嵌套的 configuration 必须是静态类。

package com.wl;

import org.springframework.context.annotation.Configuration;

@Configuration // 相当于 applicationContext.xml
public class ApplicationContext{
}

@ComponentScan 作用于类上，自动扫描组件

作用：扫描指定包下的组件，意思就是把指定包下有 @Component 或 @Controller 或 @Service或 @Repository 注解标注的类，注入到 spring 容器中。

使用示例：

Test 类

package com.wl.test;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

import com.wl.ioc.Apple;

@Configuration
@ComponentScan("com.wl.ioc")  // 等同于
public class Test {

    public static void main(String[] args) {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(Test.class);
        Apple apple = (Apple) ctx.getBean("apple");
        apple.show();
    }
}

Apple 类

package com.wl.ioc;

import org.springframework.stereotype.Component;

@Component
public class Apple implements Fruit {

    @Override
    public void show() {
        System.out.println("apple");
    }
}

@Bean 作用于返回实例的方法上

作用：返回 Bean 实例，相当于中的部分。
属性：
value
name：默认为方法名，等同于 value，相当于 bean 的名称，二者不能同时使用。
autowire ：表示该 bean 自动装配的类型，不推荐使用。
参数：Autowire.NO（默认），Autowire.BY_NAME，Autowire.BY_TYPE
initMethod：对象初始化调用方法。
destroyMethod：对象销毁调用方法。
使用示例

Test 类

package com.wl.test;

import org.springframework.beans.factory.annotation.Autowire;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

import com.wl.ioc.Banana;

@Configuration
@ComponentScan("com.wl.ioc")
public class Test {

    public static void main(String[] args) {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(Test.class);
        Banana banana = (Banana) ctx.getBean("bana");
        banana.show();
    }
    
    @Bean(name = "bana")  // 不需要 Banana 类写 @Component 注解了，写了也不会报错
    public static Banana banana() {
        return new Banana();
    }
}

Banana 类

package com.wl.ioc;

public class Banana implements Fruit {

    @Override
    public void show() {
        System.out.println("banana");
    }

    public void init() {
        System.out.println("banana init");
    }

    public void destroy() {
        System.out.println("banana destroy");
    }

}

@Component 作用于类上

作用：将当前类交给 spring bean 工厂管理。
属性：value 不写，默认 value 值为类名（类名首字母小写）。
使用示例：
Fruit 接口

package com.wl.ioc;

public interface Fruit {
    void show();
}

Apple 类（要交给 bean 工厂管理的类）

package com.wl.ioc;

import org.springframework.stereotype.Component;

@Component(value = "apple")  // 等同于 
public class Apple implements Fruit {

    @Override
    public void show() {
        System.out.println("apple");
    }
}

Test 类

package com.wl.test;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

import com.wl.ioc.Apple;

@Configuration
@ComponentScan("com.wl.ioc")
public class Test {

    public static void main(String[] args) {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(Test.class);
        Apple apple = (Apple) ctx.getBean("apple");
        apple.show();
    }
}

@Controller，@Service 和 @Repository 就是更加细化的 @Component ，使用方式与 @Component 相同。

@Controller：用于标注控制层，控制层
@Service：用于标注服务层，service 层
@Repository：用于标注数据访问层，dao 层

@RestController 作用于类上

@RestController = @Controller + @ResponseBody
作用：用于返回 json 数据。
使用示例（对比 IndexController1 和 IndexController2 完全理解）
IndexController1

package com.wl.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.wl.model.Person;

@Controller
public class IndexController1 {

    @RequestMapping("/IndexController1/index1")
    public String index1() {
        return "index";
    }

    @RequestMapping("/IndexController1/index2")
    @ResponseBody
    public Object index2() {
        Person person = new Person("张三", "男");
        return person;
    }
}

IndexController2

package com.wl.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.wl.model.Person;

@RestController
public class IndexController2 {

    @RequestMapping("/IndexController2/index1")
    public String index1() {
        return "index";
    }

    @RequestMapping("/IndexController2/index2")
    public Object index2() {
        Person person = new Person("张三", "男");
        return person;
    }
}

访问路径为：http://localhost:8080/IndexController1/index1
返回结果：index 页面（index.html 或 index.jsp）

访问路径为：http://localhost:8080/IndexController1/index2
返回结果：{"name":"张三","gender":"男"}

访问路径为：http://localhost:8080/IndexController2/index1
返回结果：index（字符串）

访问路径为：http://localhost:8080/IndexController2/index2
返回结果：{"name":"张三","gender":"男"}

@Scope 作用于类上或配合 @Bean使用

作用：声明 bean 的作用域。
五种作用域：singleton（默认），prototype，request，session，global-session
作用域的说明参照三、Bean的作用域及生命周期

@Autowired 作用于类成员变量，方法和构造函数，最常用

@Autowired 是 Spring 提供的注解
作用：按照类型注入。
注意：

如果该类型在 IoC 容器中不止一个，就会按照名称注入。
如果在 IoC 容器中没有找到该类型，则抛出异常，可以用 required=false 使注入类型可以为空。

@Resource 作用于类成员变量，方法和构造函数

@Resource 是 jdk 提供的注解，是 JSR250 规范实现的
作用：按照 bean 的名称（name）注入。

@Inject 作用于类成员变量，方法和构造函数

@Inject 是 jdk 提供的注解，是 JSR330 规范实现的
作用：按照类型注入，没有 required 属性。

@Qualifier 作用于类成员变量时必须与`@Autowired`连用，给方法参数注入时才可单独使用

作用：当 IoC 容器中同一类型存在多个 bean 实例，则需要使用 @Qualifier 注解指定注入的 bean 名称

@PostConstruct 用于指定初始化方法用在方法上

作用：对象初始化调用方法，等同于 @Bean 中的 initMethod

@PreDestory 用于指定销毁方法（用在方法上）

作用：对象销毁调用方法，等同于 @Bean 中的 destroyMethod

@RequestMapping 作用于`TYPE`（Class, interface包括注解和枚举类型）和`METHOD`

作用：接收浏览器发到控制器的请求，与其相似的还有@GetMapping，@PostMapping，@PutMapping，@DeleteMapping，@PatchMapping，主要属性如下

path 指定请求路径的url
value 和path属性是相同
method 指定该方法的请求方式
params 指定限制请求参数的条件
headers 发送的请求中必须包含的请求头

@GetMapping 作用于`METHOD`

作用：处理 get 请求，

@PostMapping 作用于`METHOD`

作用：处理 post 请求，侧重添加

@DeleteMapping 作用于`METHOD`

作用：处理 delete 请求，侧重删除

@PutMapping 作用于`METHOD`

作用：处理 put 请求。侧重整体修改，一般修改都用这个

@PatchMapping 作用于`METHOD`

作用：处理 patch 请求，侧重局部修改，这个还没用过

@RequestBody 作用于`PARAMETER`

作用：用于接收前端传递给后端的 json 串，经常与@Valid或 @Validated一起使用，它会将 json 中的 key 与实体类中的属性实装（调用 setter）

@Validated 作用于`PARAMETER`，`TYPE`，`METHOD`

作用：校验传入参数是否符合规范，来自org.springframework.validation.annotation包

@Valid 作用于`PARAMETER`，`METHOD`，`FIELD`，`CONSTRUCTOR`，`PARAMETER`，`TYPE_USE`

作用：校验传入参数是否符合规范，来自javax.validation包

@RequestParam 作用于`PARAMETER`

作用：将请求参数绑定到控制器的方法参数上
属性：name / value 作用一样；required是否必传；defaultValue默认值

@PathVariable 作用于`PARAMETER`

作用：将URL中占位符参数{xxx}绑定到控制器类的方法形参中，RESTful风格请求（了解RESTful）
属性：name / value 作用一样，required是否必传

package com.wl.controller;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @ModelAttribute
    public void updateById(@PathVariable(name = "id",required = false) String id) {
        String str = "hello";
        return str + id;
    }

    @RequestMapping("/update")
    public String update(){
        return "hello";
    }
}

访问路径为：http://localhost:8080/update/45
运行结果：hello45
访问路径为：http://localhost:8080/update/
运行结果：hello

@ModelAttribute 作用于`PARAMETER`，`METHOD`

作用：作用在方法上，表示当前方法会在控制器方法前执行；作用在参数上，获取指定的数据给参数赋值。

package com.wl.controller;

import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @RequestMapping("/update/{id}")
    public void beforeMethodExecute(Model model) {
        String str = "hello";
        model.addAttribute("str", str);
    }

    @RequestMapping("/test1")
    public String test1(Model model) {
        return model.getAttribute("str");
    }

    @RequestMapping("/test2")
    public String test2(@ModelAttribute("str") String str) {
        return str;
    }
}

访问路径:http://localhost:8080/test1
运行结果：hello
访问路径:http://localhost:8080/test2
运行结果：hello

六、Spring 中注解的使用及区别

@Configuration 作用于类上

@ComponentScan 作用于类上，自动扫描组件

@Bean 作用于返回实例的方法上

@Component 作用于类上

@Controller，@Service 和 @Repository 就是更加细化的 @Component ，使用方式与 @Component 相同。

@RestController 作用于类上

@Scope 作用于类上或 配合 @Bean使用

@Autowired 作用于类成员变量，方法和构造函数，最常用

@Resource 作用于类成员变量，方法和构造函数

@Inject 作用于类成员变量，方法和构造函数

@Qualifier 作用于类成员变量时必须与@Autowired连用，给方法参数注入时才可单独使用

@PostConstruct 用于指定初始化方法用在方法上

@PreDestory 用于指定销毁方法（用在方法上）

@RequestMapping 作用于TYPE（Class, interface包括注解和枚举类型）和METHOD

@GetMapping 作用于METHOD

@PostMapping 作用于METHOD

@DeleteMapping 作用于METHOD

@PutMapping 作用于METHOD

@PatchMapping 作用于METHOD

@RequestBody 作用于PARAMETER

@Validated 作用于PARAMETER，TYPE，METHOD

@Valid 作用于PARAMETER，METHOD，FIELD，CONSTRUCTOR，PARAMETER，TYPE_USE

@RequestParam 作用于PARAMETER

@PathVariable 作用于PARAMETER

@ModelAttribute 作用于PARAMETER，METHOD

你可能感兴趣的:(六、Spring 中注解的使用及区别)

@Scope 作用于类上或配合 @Bean使用

@Qualifier 作用于类成员变量时必须与`@Autowired`连用，给方法参数注入时才可单独使用

@RequestMapping 作用于`TYPE`（Class, interface包括注解和枚举类型）和`METHOD`

@GetMapping 作用于`METHOD`

@PostMapping 作用于`METHOD`

@DeleteMapping 作用于`METHOD`

@PutMapping 作用于`METHOD`

@PatchMapping 作用于`METHOD`

@RequestBody 作用于`PARAMETER`

@Validated 作用于`PARAMETER`，`TYPE`，`METHOD`

@Valid 作用于`PARAMETER`，`METHOD`，`FIELD`，`CONSTRUCTOR`，`PARAMETER`，`TYPE_USE`

@RequestParam 作用于`PARAMETER`

@PathVariable 作用于`PARAMETER`

@ModelAttribute 作用于`PARAMETER`，`METHOD`