Spring注解

最新推荐文章于 2022-11-08 16:58:40 发布

fzzlov

最新推荐文章于 2022-11-08 16:58:40 发布

阅读量166

点赞数

分类专栏：开发常用知识文章标签： spring注解 swagger注解 springboot注解常用注解

本文链接：https://blog.csdn.net/fzzlov/article/details/100040489

版权

开发常用知识专栏收录该内容

4 篇文章 0 订阅

订阅专栏

常用注解

1、@SpringBootApplication

这是 Spring Boot 最最最核心的注解，用在 Spring Boot 主类上，标识这是一个 Spring Boot 应用，用来启动 Spring Boot。这个注解就是 @SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan 这三个注解的组合，也可以用这三个注解来代替 @SpringBootApplication注解。

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

2、@EnableAutoConfiguration

允许 Spring Boot 自动配置注解，开启这个注解之后，Spring Boot 就能根据当前类路径下的包或者类来配置 Spring Bean。如：比如当它检测到数据库驱动程序时，会自动匹配你配置的项目数据库连接信息。可以通过@EnableAutoConfiguration(exclude = “”)排除特定的自动配置类.

3、@Configuration

这是 Spring 3.0 添加的一个注解，用来代替 applicationContext.xml 配置文件，所有这个配置文件里面能做到的事情都可以通过这个注解所在类来进行注册。

4、@SpringBootConfiguration

这个注解就是 @Configuration 注解的变体，只是用来修饰是 Spring Boot 配置而已，或者可利于 Spring Boot 后续的扩展。

5、@ComponentScan

这是 Spring 3.1 添加的一个注解，用来代替配置文件中的 component-scan 配置，开启组件扫描，即自动扫描包路径下的 @Component 注解进行注册 bean 实例到 context 中。

另外，@ComponentScans 是可重复注解，即可以配置多个，用来配置注册不同的子包。

6、@Conditional

这是 Spring 4.0 添加的新注解，用来标识一个 Spring Bean 或者 Configuration 配置文件，当满足指定的条件才开启配置。

yml中配置：
spring: 
   env: TEST


/**
 * @author : fzz
 */
@Component
public class TestCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String env = context.getEnvironment().getProperty("spring.env");
        if ("TEST".equals(env)){
            return true;
        }
        return false;
    }
}

/**
 * @author : fzz
 */
@Component
public class DevCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String env = context.getEnvironment().getProperty("spring.env");
        if ("DEV".equals(env)){
            return true;
        }
        return false;
    }
}

@Slf4j
@Configuration
public class ConditionConfig {
    @Bean
    @Conditional(TestCondition.class)
    public String testService(){
        log.info("=====================test========================");
        return "test";
    }
    @Bean
    @Conditional(DevCondition.class)
    public String devService(){
        log.info("=====================dev========================");
        return "dev";
    }
}

打印结果：
=====================test========================

7、@ConditionalOnBean

组合 @ConditionalBean 注解，当容器中有指定的 Bean 才开启配置。

注意：使用该注解时，注意Bean先后加载顺序，否则达不到想要的效果；可以通过@AutoConfigureBefore、@AutoConfigureAfter @AutoConfigureOrder控制先后顺序。最好使用@ConditionOnClass代替

8、@ConditionalOnMissingBean

组合 @ConditionalOnMissingBean 注解，和 @ConditionalOnBean 注解相反，当容器中没有指定的 Bean 才开启配置。

9、@ConditionalOnClass

组合 @ConditionalOnClass 注解，当容器中有指定的 Class 才开启配置。

10、@ConditionalOnMissingClass

组合 @ConditionalOnMissingClass 注解，和 @ConditionalOnMissingClass 注解相反，当容器中没有指定的 Class 才开启配置。

11、@ConditionalOnWebApplication

组合 @ConditionalOnWebApplication 注解，当前项目类型是 WEB 项目才开启配置。

当前项目有以下 3 种类型。

public @interface ConditionalOnWebApplication {

	/**
	 * The required type of the web application.
	 * @return the required web application type
	 */
	Type type() default Type.ANY;

	/**
	 * Available application types.
	 */
	enum Type {

		/**
		 * Any web application will match.
		 */
		ANY,

		/**
		 * Only servlet-based web application will match.
		 */
		SERVLET,

		/**
		 * Only reactive-based web application will match.
		 */
		REACTIVE

	}

}

@Bean
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.ANY)
public String testService(){
    log.info("=====================test========================");
    return "test";
}

12、@ConditionalOnNotWebApplication

组合 @ConditionalOnNotWebApplication 注解，和 @ConditionalOnWebApplication 注解相反，当前项目类型不是 WEB 项目才开启配置。

13、@ConditionalOnProperty

组合 @ConditionalOnProperty 注解，当指定的属性有指定的值时才开启配置。

14、@ConditionalOnExpression

组合 @ConditionalOnExpression 注解，当 SpEL 表达式为 true 时才开启配置。

15、@ConditionalOnJava

组合 @ConditionalOnJava 注解，当运行的 Java JVM 在指定的版本范围时才开启配置。

16、@ConditionalOnResource

组合 @ConditionalOnResource 注解，当类路径下有指定的资源才开启配置。

17、@ConditionalOnJndi

组合 @ConditionalOnJndi 注解，当指定的 JNDI 存在时才开启配置。

18、@ConditionalOnCloudPlatform

组合 @ConditionalOnCloudPlatform 注解，当指定的云平台激活时才开启配置。

19、@ConditionalOnSingleCandidate

组合 @ConditionalOnSingleCandidate 注解，当指定的 class 在容器中只有一个 Bean，或者同时有多个但为首选时才开启配置。

20、@ConfigurationProperties

用来加载额外的配置（如 .properties 文件），可用在 @Configuration 注解类，或者 @Bean注解方法上面。

21、@EnableConfigurationProperties

一般要配合 @ConfigurationProperties 注解使用，用来开启对 @ConfigurationProperties注解配置 Bean 的支持。

22、@AutoConfigureAfter

用在自动配置类上面，表示该自动配置类需要在另外指定的自动配置类配置完之后。

如 Mybatis 的自动配置类，需要在数据源自动配置类之后。

@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration {

23、@AutoConfigureBefore

这个和 @AutoConfigureAfter 注解使用相反，表示该自动配置类需要在另外指定的自动配置类配置之前。

24、@AutoConfigureOrder

这个 @AutoConfigureOrder 注解，表示该自动配置类加载级别，值越小，优先级越高。

25、@Import

这是 Spring 3.0 添加的新注解，用来导入一个或者多个 @Configuration 注解修饰的类，这在 Spring Boot 里面应用很多。

26、@ImportResource

这是 Spring 3.0 添加的新注解，用来导入一个或者多个 Spring 配置文件，这对 Spring Boot 兼容老项目非常有用，因为有些配置无法通过 Java Config 的形式来配置就只能用这个注解来导入。

全局异常处理

1、@ControllerAdvice：包含@Component。可以被扫描到。统一处理异常。

2、@ExceptionHandler（Exception.class）：用在方法上面表示遇到这个异常就执行以下方法。

@ControllerAdvice(basePackages ="com.fzz.web.controller")
public class ExceptionControllerAdvice {
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public ReturnModel<String> myExceptionHandler(Exception e){
        ReturnModel<String> model = new ReturnModel<String>();
        model.setCode(-1);
        model.setMessage("系统忙,请稍后再试试吧!");
        model.setSubCode(null);
        return model;
    }
}

springMvc相关注解

1、@RequestMapping：@RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

该注解有六个属性：

params:指定request中必须包含某些参数值是，才让该方法处理。
headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
value:指定请求的实际地址，指定的地址可以是URI Template 模式
method:指定请求的method类型， GET、POST、PUT、DELETE等
consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;
produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

2、@RequestParam：用在方法的参数前面。

/**
 * 这里类上面要用@RestController注解
 * 该注解相当于@RequestMapping(value = "fzz/getUserById" method = RequestMethod.GET )
 *
 **/
@GetMapping(value = "fzz/getUserById")
public ReturnModel getUserById(
			@RequestParam(required = true, value = "uid") Integer uid) {
		//do something;
	}

3、@PathVariable:路径变量。如

@RequestMapping(“fzz/user/{Address}”)
public String getByAddress(@PathVariable String Address){
	//do something;
}

Swagger中model注解

@ApiModel(value = "user对象模型")//model名字
public class User implements Serializable {
    @JSONField(name="Uid")	//	解决传输大小写问题
	@ApiModelProperty(value = "用户ID" required = true) // 属性名字，是否毕传
	private int uid;
	
	@ApiModelProperty(value = "用户头像")
	private String userHeadImg;
	
	@ApiModelProperty(value = "用户名")
	private String userName;
	
	@ApiModelProperty(value = "昵称")
	private String nickName;
    
    …………
}

@RestController
@RequestMapping(value = "/fzz",produces = { "application/json;charset=UTF-8" })
@Api(tags = "UserController", description = "用户相关接口")
public class UserController extends BaseController {
	@Reference(version = "1.0.0")
	private IUserService iuserService;

	@GetMapping(value = "/getUserAll")
	@ApiOperation(value = "获取user列表，根据条件")
	@ApiImplicitParams({
        //	注意dataType必须是基本类型
        @ApiImplicitParam(name = "sex", value = "0:全部;1:男；2：女 默认所有", required = false, paramType = "query", dataType = "int")})
	public ReturnModel getUserAll(
			@RequestParam(defaultValue="0")Integer sex) {
		// //do something;
	}