欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

springboot-java常用注解

程序员文章站 2022-06-28 16:10:05
@SpringBootApplication定义在main方法入口类处,用于启用springboot应用项目。@EnableAutoConfiguration让spring boot根据类类路径中的jar包依赖当前项目自动配置。@ImportResource加载xml配置,一般放在main启动类上。@ImportResource("classpath*:/spring/*.xml") 单个@ImportResource({"classpath*:/spring/1.xml","...

@SpringBootApplication

定义在main方法入口类处,用于启用springboot应用项目。

@EnableAutoConfiguration

让spring boot根据类类路径中的jar包依赖当前项目自动配置。

@ImportResource

加载xml配置,一般放在main启动类上。

@ImportResource("classpath*:/spring/*.xml")  单个

@ImportResource({"classpath*:/spring/1.xml","classpath*:/spring/2.xml"})   多个

@Value

application.properties定义属性,直接使用@Value注入即可。

public class A{
	 @Value("${push.start:0}")    如果缺失,默认值为0
     private Long  id;
}

@ConfigationProperties(prefix = “person”)

可以新建一个properties文件,ConfigationProperties的属性prefix指定properties的配置的前缀,location指定properties文件的位置。

@ConfigurationProperties(prefix="person")
public class PersonProperties {
	
	private String name ;
	private int age;
}

@EnableConfigationProperties

使ConfigationProperties生效,从Ioc容器中获取bean。

@RestController

组合Controller与ResponseBody,在Controller层使用。

@RequestMapping("/api/test")

用来映射web请求(访问路径与参数),处理类与方法, 可以注解在类和方法上,注解在方法上的路径会继承注解在类上的路径。
produces属性: 定制返回的response的媒体类型和字符集,或需返回值是json对象。

@RequestMapping(value="/api2/copper",produces="application/json;charset=UTF-8",method = RequestMethod.POST)

@RequestParam

获取request请求的参数值。

 public List<CopperVO> getOpList(HttpServletRequest request,
                                    @RequestParam(value = "pageIndex", required = false) Integer pageIndex,
                                    @RequestParam(value = "pageSize", required = false) Integer pageSize) {
 
  }

@ResponseBody

支持将返回值放在response内,而不是返回一个页面。比如Ajax接口,可以用此注解返回数据而不是页面,可放置在返回值前或者方法前。

@Bean

@Bean(name=“bean的名字”,initMethod=“初始化时调用方法名字”,destroyMethod=“close”)
定义在方法上,在容器内初始化一个bean实例类。

@Bean(destroyMethod="close")
@ConditionalOnMissingBean
public PersonService registryService() {
		return new PersonService(); 
	}

@Service

用于标注业务层组件

@Controller

用于标注控制层组件,如struts中的action。

@Repository

用于标注数据访问组件,即Dao组件。

@Component

泛指组件,当组件不好归类的时候使用。

@PostConstruct

spring容器初始化时要使用该方法。

@PostConstruct  
public void init() {   
}   

@PathVariable

用于获取请求url中的动态参数。

@Controller  
public class TestController {  

     @RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)  
     public String getLogin(@PathVariable("userId") String userId,  
         @PathVariable("roleId") String roleId){
           
         System.out.println("User Id : " + userId);  
         System.out.println("Role Id : " + roleId);  
         return "hello";  
     
     }  
}

@ComponentScan

注解会告知Spring扫描指定的包来初始化Spring。

@ComponentScan(basePackages = "com.bbs.xx")

@EnableZuulProxy

路由网关的主要目的是为了让所有的微服务对外只有一个接口,我们只需访问一个网关地址,即可由网关将所有的请求代理到不同的服务中。Spring Cloud是通过Zuul来实现的,支持自动路由映射到在Eureka Server上注册的服务。Spring Cloud提供了注解@EnableZuulProxy来启用路由代理。

@Autowired

在默认情况下使用 @Autowired 注释进行自动注入时,Spring 容器中匹配的候选 Bean 数目必须有且仅有一个。当找不到一个匹配的 Bean 时,Spring 容器将抛出 BeanCreationException 异常,并指出必须至少拥有一个匹配的 Bean。 当不能确定 Spring 容器中一定拥有某个类的 Bean 时,可以在需要自动注入该类 Bean 的地方可以使用 @Autowired(required = false),这等于告诉 Spring: 在找不到匹配 Bean 时也不报错。
@Qualifier可以缩小范围,指定注入对象的id。
@request:这个属性/方法必须复制,相当于@Autowired(request=true)。

@Configuration

@Configuration("name")//表示这是一个配置信息类,可以给这个配置类也起一个名称
@ComponentScan("spring4")//类似于xml中的<context:component-scan base-package="spring4"/>
public class Config {

    @Autowired//自动注入,如果容器中有多个符合的bean时,需要进一步明确
    @Qualifier("compent")//进一步指明注入bean名称为compent的bean
    private Compent compent;

    @Bean//类似于xml中的<bean id="newbean" class="spring4.Compent"/>
    public Compent newbean(){
        return new Compent();
    }   
}

@Import(Config1.class)

导入Config1配置类里实例化的bean。

@Configuration
public class CDConfig {
    @Bean   // 将SgtPeppers注册为 SpringContext中的bean
    public CompactDisc compactDisc() {
        return new CompactDisc();  // CompactDisc类型的
    }
}

@Configuration
@Import(CDConfig.class)  //导入CDConfig的配置
public class CDPlayerConfig {

    @Bean(name = "cDPlayer")
    public CDPlayer cdPlayer(CompactDisc compactDisc) {  
         // 这里会注入CompactDisc类型的bean
         // 这里注入的这个bean是CDConfig.class中的CompactDisc类型的那个bean
        return new CDPlayer(compactDisc);
    }
}

@Order

Order(1),值越小,优先级越高,越先运行。只对list有效,对map无效。

@ConditionalOnExpression

@Configuration
@ConditionalOnExpression("${enabled:false}")
public class BigpipeConfiguration {
    @Bean
    public OrderMessageMonitor orderMessageMonitor(ConfigContext configContext) {
        return new OrderMessageMonitor(configContext);
    }
}

开关为true的时候才实列化bean。

@ConditionalOnProperty

这个注解能够控制某个 @Configuration 是否生效。具体操作是通过其两个属性name以及havingValue来实现的,其中name用来从application.properties中读取某个属性值,如果该值为空,则返回false;如果值不为空,则将该值与havingValue指定的值进行比较,如果一样则返回true;否则返回false。如果返回值为false,则该configuration不生效;为true则生效。

@ConditionalOnClass

该注解的参数对应的类必须存在,否则不解析该注解修饰的配置 类。

@Configuration
@ConditionalOnClass({Gson.class})
public class GsonAutoConfiguration {
    public GsonAutoConfiguration() {
    }

    @Bean
    @ConditionalOnMissingBean
    public Gson gson() {
        return new Gson();
    }
}

@ConditionalOnMisssingClass({ApplicationManager.class})

如果存在它修饰的类的bean,则不需要再创建这个bean。

@ConditionOnMissingBean(name = “example”)

表示如果name为“example”的bean存在,该注解修饰的代码块不执行。

本文地址:https://blog.csdn.net/soulmateguai/article/details/113859688

相关标签: java基础