SpringBoot-32-常用注解汇总2-阿里云开发者社区

SpringBoot-32-常用注解汇总2

2023-08-30 76

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： SpringBoot-32-常用注解汇总2在上一章节我们已经讲解了SpringBoot中Controller相关注解,没有看的可以了解一下SpringBoot-31-Controller相关注解详解

SpringBoot-32-常用注解汇总2

在上一章节我们已经讲解了SpringBoot中Controller相关注解,没有看的可以了解一下SpringBoot-31-Controller相关注解详解

请求参数类注解

@PathVariable

表示接收请求路径中占位符的值，通过路径映射取值，参数都用 “/” 按照约定的顺序拼接在方法后面，格式为，格式如下：

@PathVariable("id")
通过@PathVariable，可以将URL中的占位符{id}绑定到处理器类的方法
@GetMapping("/variable/{id}/{name}")
请求路径：http://localhost:8888/request/variable/1/james

实现代码如下

    @GetMapping("/variable/{id}/{name}")
    public String Test(@PathVariable("id")String id,@PathVariable("name")String name){
        return "id: "+id +" name: "+name;
    }

注意如下：

测试结果如下：

@RequestParam

@RequestParam主要用于将请求参数区域的数据映射到控制层方法的参数上,，使用键值对方式取值，方法名后面加 “?” 开始，多个参数用 “&” 拼接，格式如下

@RequestParam(value = "id",required = false,defaultValue ="1")
请求路径：http://localhost:8888/request/param?name=param

代码实现如下：

    @GetMapping("/param")
    public String param(@RequestParam(value = "id",required = false,defaultValue ="1")String id,
                        @RequestParam(value = "name",required = true)String name){
        return "id: "+id +" name: "+name;
    }

注意：**@RequestParam**有四个参数

name：绑定参数的名称

value：和参数name表示的意思一样是name的别名

required：标记参数是否是必须的

defaultValue:如果请求中没有这个参数，那么就使用默认值

测试结果如下：

测试链接：http://localhost:8888/request/param?name=james

@RequestHeader

@RequestHeader把Request请求header部分的值绑定到方法的参数上，也有四个参数和@RequestParam参数含义一样

代码实现如下：

    @GetMapping(value="/header")
    public String header(
            @RequestHeader("User-Agent") String userAgent,
            @RequestHeader(value="Accept") String[] accepts){
        return "User-Agent: "+userAgent+"  accept:  "+accepts.toString();
    }

我们使用浏览器测试连接http://localhost:8888/request/header

结果如下：

@CookieValue

@CookieValue绑定Cookie数据值，也有四个参数和@RequestParam参数含义一样

代码如下:

    @GetMapping(value="/cookie")
    public String Cookie(
            @CookieValue(value="SESSIONID", defaultValue="") String SESSIONID){
        return "SESSIONID: "+SESSIONID;
    }

测试结果：因为我们Cookie为空，所以返回结果如下:

@Configuration相关注解

@Configuration

@Configuration注解是在Spring 3.0开始添加进去的，用来代替applicationContext.xml配置文件，所以只要是这个配置文件可以实现的事情，都可以通过这个注解在类中进行注册相当于标签。

例子

@Configuration
public class MyConfigTest {
    public MyConfigTest(){
        System.out.println("my config test");
    }
}

启动程序，springboot容器初始化时就自动加载这个类了

@Bean注解

@Bean注解使用在方法上面，相当于之前配置文件.xml中的标签，用于注册bean对象，一般是和**@Configuration**注解配合使用的。

    @Bean
    public String configtest(){
        return "hello config bean";
    }

@Autowired

@Autowired 是根据类型（byType）注入的，然后在找到type类型的bean时，如果发现有异常（不唯一等），会再去根据name去找bean注入。

在Controller中获取并使用我们的configtest的bean，代码如下

@RestController
public class ConfigController {
    @Autowired
    private String configtest;
    @GetMapping("beanconfig")
    public String beanconfig(){
        return configtest;
    }
}

测试结果：

@Qualifier注解

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用

添加配置类

@Data
public class TestConfigurationProperties {
    private String  epochStr;
    private String timeBits;
    private String workerBits;
    private String seqBits;
}

在MyConfigTest类中注入bean

    @Bean("testconfigurationproperties2")
    public TestConfigurationProperties testConfigurationProperties2(){
        TestConfigurationProperties properties = new TestConfigurationProperties();
        properties.setEpochStr("test2");
        properties.setSeqBits("test2");
        properties.setTimeBits("test2");
        properties.setWorkerBits("test2");
        return properties;
    }
    @Bean("testconfigurationproperties3")
    public TestConfigurationProperties testConfigurationProperties3(){
        TestConfigurationProperties properties = new TestConfigurationProperties();
        properties.setEpochStr("test3");
        properties.setSeqBits("test3");
        properties.setTimeBits("test3");
        properties.setWorkerBits("test3");
        return properties;
    }

在controller中实现

    @Autowired
    @Qualifier("testconfigurationproperties2")
    private TestConfigurationProperties configurationProperties2;
    @Autowired
    @Qualifier("testconfigurationproperties3")
    private TestConfigurationProperties configurationProperties3;
    @GetMapping("/configproperties2")
    public String configproperties2(){
        return configurationProperties2.toString();
    }
    @GetMapping("/configproperties3")
    public String configproperties3(){
        return configurationProperties3.toString();
    }

测试结果

分别访问http://localhost:8888/configproperties2和http://localhost:8888/configproperties2展示测试结果

@Resource

@Resource根据Bean的name去获取bean**不像@Autowired **是通过找type类型的bean时,如果没有指定name属性，并且按照默认的名称仍然找不到依赖对象时， @Resource注解会回退到按类型装配。但一旦指定了name属性，就只能按名称装配了

controller代码实现如下

    @Resource(name = "testconfigurationproperties3")
    private TestConfigurationProperties configurationProperties4;
    @GetMapping("/configurationProperties4")
    public String configurationProperties4(){
        return configurationProperties4.toString();
    }

测试结果如下

Properties使用的相关注解

====================

@PropertySource

我们在开发的时候经常使用配置文件，使用@PropertySource注解我们可以注册一个配置文件，一般和@Configuration配合使用。

在src\main\resources文件夹下添加test.properties属性文件

test.epochStr=2019-12-29
test.timeBits=30
test.workerBits=32
test.seqBits=1

注册Properties文件,一般和@Configuration注解配合使用

@Configuration
@PropertySource("classpath:test.properties")
public class Testproperties {
}

注意yaml文件不能用在@PropertySource中。如果你使用@PropertySource，则必须指定properties文件

@Value注解

将test.properties文件中的属性，赋值给普通变量，可以直接在变量声明之上添加@Value()注解：

@Data
@Configuration
@PropertySource("classpath:test.properties")
public class Testproperties {
    @Value("${test.epochStr}")
    private String  epochStr;
    @Value("${test.timeBits}")
    private String timeBits;
    @Value("${test.workerBits}")
    private String workerBits;
    @Value("${test.seqBits}")
    private String seqBits;
}

在Controller中获取并使用我们的Testproperties的bean，代码如下

@RestController
public class PropertyController {
    @Autowired
    private Testproperties testproperties;
    @GetMapping("/properties")
    public String testproperties(){
        return testproperties.toString();
    }
}

测试结果

@ConfigurationProperties

@ConfigurationProperties默认读取的就是application.yml或者application.properties文件和@PropertySource注解很相似

在application.yml中配置如下

server:
  port: 8888
uid:
  epochStr: 'yml'
  timeBits: 30
  workerBits: 32
  seqBits: 1

使用@ConfigurationProperties注解结合@Configuration将我们的属性封装成Bean

@Data
@Configuration
@ConfigurationProperties(prefix = "uid")
public class UidConfigurationProperties {
    private String  epochStr;
    private String timeBits;
    private String workerBits;
    private String seqBits;
}

在Controller中获取并使用我们的TestConfigurationProperties的bean，代码如下

    @Autowired
    private UidConfigurationProperties uidConfigurationProperties;
    @GetMapping("/uid")
    public String uid(){
        return uidConfigurationProperties.toString();
    }