SpringBoot-32-常用注解汇总2

简介: 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;
    }



注意如下:

测试结果如下:






fde73e5baa2ee908002a39c69266c027.png

@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


f43e6bc54f68d3091107bbeabb59de91.png


@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

结果如下:


0747d03870642f5a52b7108928990ab1.png

@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展示测试结果

928046a48ce558abe6e8042ed4277070.png

d2928b52f02eec697f3e46c8d17ccc4d.png


@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();
    }



  • 测试结果如下


04f86d33a7928d61d4f6468f409ed0ff.png


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();
    }
  • 测试结果

目录
相关文章
|
21天前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
42 0
|
2月前
|
Java Spring 容器
如何解决spring EL注解@Value获取值为null的问题
本文探讨了在使用Spring框架时,如何避免`@Value("${xxx.xxx}")`注解导致值为null的问题。通过具体示例分析了几种常见错误场景,包括类未交给Spring管理、字段被`static`或`final`修饰以及通过`new`而非依赖注入创建对象等,提出了相应的解决方案,并强调了理解框架原理的重要性。
152 4
|
2月前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
28天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
48 4
SpringBoot必须掌握的常用注解!
|
7天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
23 2
|
2月前
|
XML Java 数据格式
Spring从入门到入土(bean的一些子标签及注解的使用)
本文详细介绍了Spring框架中Bean的创建和使用,包括使用XML配置文件中的标签和注解来创建和管理Bean,以及如何通过构造器、Setter方法和属性注入来配置Bean。
75 9
Spring从入门到入土(bean的一些子标签及注解的使用)
|
1月前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
108 2
|
1月前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
39 1
|
2月前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
25天前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
16 0