SpringBoot常用注解
文章目录
一、注解(annotations)列表
@SpringBootApplication :包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中:@ComponentScan让SpringBoot扫描到Configguration类并把它加入到程序上下文。
@Configuration等同于spring的xml配置文文件,使用java代码可以检查类型安全,
@EnableAutoConfiguration 自动配置。
@ComponentScan 组件扫描。可以自动发现和装配一些Bean。
@ComponentScan可配合CommandLineRunner使用,在程序启动后执行一些基础任务。
@RestController注解是@Controller和@ResponseBody的集合,表示这个是控制机器bean,并且是将函数的返回值至二级注入HTTP响应体中。
@Autowriable自动注入
@PathVariable 获取参数
@JsonBackReference 解决嵌套外连连接问题。
@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。
二、注解(annotations)详解
@SpringBootApplication:申明spring boot 自动给程序进行程序进行必要的配置,这个配置等同于:@Configguration, @ComponentScan和
@EnableAutoConfiguration三个配置。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootAplication
public class Application {
public static void main (string[]args){
SpringApplication.run(Application.calss,args);
}
}
@RequrestMapping :提供路由信息,负责URL到Controller 中的具体函数的映射。
@Controller:用于定义控制器,在spring项目中有由控制器负责将用户发来的URL请求转发到对应的接口(service层),一般这个注解在类中配合@RequestMapper使用.
代码显示如下:
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping
/**
* 计划在这个controller中处理所有页面请求
* @author ldjx
*/
@Controller
@RequestMapepr("/")
public class PageController{
@RequestMapper("doIndexUI")
public String doIndexUI(){
return "index";
}
}@ResponseBody:表示该方法的返回结果直接写入HTTP responebody中,一般在异步获取数据使用。在使用RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被将解析为跳转路径,而是直接写入HTTP reponsebody中,比如异步获取json数据,加上@responsebody后,会直接返回json数据。改注解一般会配合@RequestMapepr一起使用。示例代码:
@RequestMapper("/test")
@ResponseBody
public String test(){
return "ok";
}
或者返回自定义的类型,如使用jsonResult类对数据进行封装
@RequestMaper("/testDelete")
@ResponseBody
public JsonResult doDeleteObject(Integer id){
return new JsonResult("delete ok");
}
@RestControlelr:用于标注控制层组件(如:Struts中的action),
@ResponseBody和@Controoer的集合。
代码示例如下:
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import com.cy.pj.common.pojo.JsonResult;
import com.cy.pj.sys.service.SysLogService;
/**
* 尽量将返回页面的请求处理与数据处理的controller分开
* 只处理页面返回请求的使用@controller即可,将@RestController使用在返回数据处理的controller上
* 避免了每个方法上都加@ResponseBody的麻烦
* @author ldjx
*/@RestController //相当于@ResponseBody + @Controlelr
@RequestMapper("/test/")
public class SysLogController{
@Autowird
private TestService testService;
@RequestMapper("doDeleteObject")
pbulic JsonResult doDeleteObject(Integer id){
//调用业务方法执行删除操作...( testService.doDelete(id) )return new JsonResult("delete ok");
}
@RequestMapping("/doFindObjects")
pbulic JsonResult doFindObjects(){
public JsonResult doFindObjects(){
return new JsonResult(testService.findObjects());`
//业务层返回的数据封装在JsonResult对象中
}
}
}@EnableAutoConfiguration: Spring Boot自动配置 (auto-configuratin):尝试根据你添加的jar依赖自动配置你的Spring应用。例如:如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库,你可以将@EableAutoConfiguration或者@SpringBootAppliocation注解添加到一个@Configuration类上来选择自动配置,如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConguration 注解的排除属性来禁用它们。
@ComponentScan:表示该类自动发现扫描组件。个人理解为,如果扫描到有如果扫描到有@Component、@Controller、@Service等这些注解的类,并注册为Bean ,可以自动收集所有的spring组件,包扣@Configuration类。我们经常使用@ComponentsScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。
@Configuration:相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@configuration类作为项目的配置主类---可以使用@ImportResouration注解加载xml配置文件。
@import 用来导入其他配置类。
@importResource:用来加载xml配置文件。
@service:一般用在修饰service层组件。
@Repository:使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。
@Value:注入Spring boot application.properties配置的属性的值。示例代码:
@Value(value = "#{message}") private String message;
@Inject:等价于默认的@Autowired,只是没有required属性;
@Component:泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
@Bean:用@Bean标注方法等价于XML中配置的bean,放在方法的上面,而不是类,告诉Spring容器,你可以从下面这个方法中拿到一个Bean。
示例代码:public class ObjectTest{ }
//------------------------------------------------------------------------------
/*
- @Bean 注解通常会应用在一些配置类(由@Configuration注解描述)中,用于描述
- 具备返回值的方法,然后系统底层会通过反射调用其方法,获取对象基于作用域将对象
- 进行存储或应用。
- @Bean 应用场景:第三方资源的整合及配置。
*/
//@Bean("obj") //为返回值指定名字
@Bean //Spring容器中由@Bean描述的方法的返回值,对应的名字默认为方法名
public ObjectTest testObj() {
return new ObjectTest();}
@AutoWired:自动注入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。
@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者,具体使用方式如下:public interface TestQua{}
public class QuaImpl01 implements TestQua{ }
public class QuaImpl02 implements TestQua{ }
@SpringBootTest//该注解用于SpringBoot项目中的测试类
public class CacheTest {
//@Autowired注解描述属性时,系统底层会基于属性类型从spring容器查找对象,假如有多个类型都满足注入要求,则还会基于属性名进行查找,检测哪个bean名字与属性相同,假如有相同的则直接取相同进行注入,没有则抛出异常
@Autowired
//@Qualifier注解配合@Autowired注解使用,用于指定将哪个bean的名字对应的对象注入给描述的属性
//@Qualifier("quaImpl01")
@Qualifier("quaImpl02")
private TestQua testQua;
@Test
void testCache() {
System.out.println("testQua="+testQua);
}}
@Resource(name="name",type="type"):没有括号内内容的话,默认byName。与@Autowired干类似的事。
@Lazy:描述Spring管理的bean对象时,可以让bean延迟构建和初始化.
延迟加载(懒加载,按需加载)应用场景:
大对象(例如一些池对象),稀少用(例如容器初始化时创建了对象也用不到).
@Scope:描述类时用于指定类实例的作用域,常用取值:
* 1)singleton :默认为单例作用域-类的实例在一个JVM内存中其实例只有一份,此作用域通常还会配置@Lazy一起使用,一般可重用对象可设计为单例,对于这样的对象spring框架不仅仅负责其创建,还会存储到bean池.
* 2)prototype (多例作用域-此作用域对象何时需要何时创建,spring框架不负责销毁)一般不可重用对象,或者说只使用一次就不再用此对象了,这样的对象就可设计为多例作用域.
@PostConstruct:此注解描述的方法为生命周期初始化方法.
@PreDestroy:此注解描述的方法为生命周期销毁方法,此方法会在对象销毁之前执行(如果是多例作用域,则不会触发此方法).
示例代码:@Scope //spring容器中的bean没有使用@Scope注解描述时默认就是单例.
//@Scope("prototype")
@Lazy //默认value属性值为true,表示此对象要延迟构建及初始化.
//@Lazy(false)//这里假如要写false,跟没有写@Lazy注解是一样的,表示不支持对象延迟构建及初始化.
@Component //此注解描述bean表示这个bean对象会由spring创建,其名字默认为类名,首字母小写.
public class ObjectPool {//bean的名字objectPool
public int size;
public ObjectPool() {//使用lazy注解后,启动项目未触发构造方法,说明没有创建此对象(延迟加载生效)
System.out.println("ObjectPool()");}
/**
* @PostConstruct 此注解描述的方法为生命周期初始化方法
* 在这样的方法中一般会为创建好的对象再此进行一些初始化.
*/@PostConstruct
public void init() {
System.out.println("init()");}
/**
*@PreDestroy 此注解描述的方法为生命周期销毁方法,此方法会在对象销毁之前执行.
* 在这样的方法中可以实现一些,资源销毁操作.
*/@PreDestroy
public void destory() {//将对象从bean池中移除之前会执行此方法
System.out.println("destory()");}
}
#### 三 JPA注解

评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论