首页 > 应用开发 > Java > 超级全面的 SpringBoot 注解介绍
一、注解(annotations)列表
1、@SpringBootApplication
包含了
@ComponentScan、@Configuration和@EnableAutoConfiguration注解。
其中@ComponentScan让Spring Boot扫描到Configuration类并把它加入到程序上下文。2、@ComponentScan
组件扫描,可自动发现和装配一些
Bean。3、@Configuration
等同于
Spring的XML配置文件;使用Java代码可以检查类型安全。4、@EnableAutoConfiguration
自动配置
5、@RestController
该注解是
@Controller和@ResponseBody的合集,表示这是个控制器Bean,并且是将函数的返回值直接填入HTTP响应体中,是REST风格的控制器。6、@Autowired
自动导入。
7、@PathVariable
获取参数。
8、@JsonBackReference
解决嵌套外链问题。
9、@RepositoryRestResourcepublic
配合spring-boot-starter-data-rest使用。
二、注解(annotations)详解
1、
@SpringBootApplication:申明让Spring Boot自动给程序进行必要的配置,这个配置等同于:@Configuration,@EnableAutoConfiguration和@ComponentScan三个配置。import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
public static void main (String[] args) {
SpringApplication.run(Application . class, args);
}
}2、
@ResponseBody:表示该方法的返回结果直接写入HTTP Response Body中,一般在异步获取数据时使用,用于构建RESTful的api。在使用
@RequestMapping后,返回值通常解析为跳转路径,加上@ResponseBody后返回结果不会被解析为跳转路径,而是直接写入HTTP Response Body中。比如异步获取
json数据,加上@ResponseBody后,会直接返回json数据。该注解一般会配合
@RequestMapping一起使用。示例代码:
@RequestMapping(“/test”)
@ResponseBody
public String test (){
return ”ok”;
}3、
@Controller:用于定义控制器类,在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层)一般这个注解在类中,通常方法需要配合注解
@RequestMapping。示例代码:
@Controller
@RequestMapping(“/demoInfo”)
publicclass DemoController {
@Autowired
private DemoInfoService demoInfoService;
@RequestMapping( "/hello")
public String hello (Map map){
System.out.println( "DemoController.hello()");
map.put( "hello", "from TemplateController.helloHtml");
// 会使用hello.html或者hello.ftl模板进行渲染显示.
return "/hello";
}
}4、
@RestController:用于标注控制层组件(如struts中的action),@ResponseBody和@Controller的合集。示例代码:
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(“/demoInfo2”)
publicclass DemoController2 {
@RequestMapping( "/test")
public String test (){
return "ok";
}
}5、
@RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射。6、
@EnableAutoConfiguration:Spring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的
classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。你可以将
@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用
@EnableAutoConfiguration注解的排除属性来禁用它们。
7、
@ComponentScan:表示将该类自动发现扫描组件。个人理解相当于,如果扫描到有
@Component、@Controller、@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用
@ComponentScan注解搜索beans,并结合@Autowired注解导入。可以自动收集所有的Spring组件,包括@Configuration类。如果没有配置的话,
Spring Boot会扫描启动类所在包下以及子包下的使用了@Service、@Repository等注解的类。8、
@Configuration:相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。9、
@Import:用来导入其他配置类。10、
@ImportResource:用来加载xml配置文件。11、
@Autowired:自动导入依赖的bean12、
@Service:一般用于修饰service层的组件13、
@Repository:使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。14、
@Bean:用@Bean标注方法等价于XML中配置的bean。15、
@Value:注入Spring bootapplication.properties配置的属性的值。示例代码:@Value(value = “#{message}”)
private String message;16、
@Inject:等价于默认的@Autowired,只是没有required属性;17、
@Component:泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。18、
@Bean:相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理。19、
@AutoWired:自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。20、
@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者,具体使用方式如下:@Autowired
@Qualifier(value = “demoInfoService”)
private DemoInfoService demoInfoService;21、
@Resource(name=”name”,type=”type”):没有括号内内容的话,默认byName。与@Autowired干类似的事。
三、JPA注解
1、
@Entity:@Table(name=”“):表明这是一个实体类。一般用于jpa这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略。2、
@MappedSuperClass:用在确定是父类的entity上。父类的属性子类可以继承。3、
@NoRepositoryBean:一般用作父类的repository,有这个注解,Spring不会去实例化该repository。4、
@Column:如果字段名与列名相同,则可以省略。5、
@Id:表示该属性为主键。6、
@GeneratedValue(strategy=GenerationType.SEQUENCE,generator= “repair_seq”):表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间切换),指定sequence的名字是repair_seq。7、
@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1):name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致。8、
@Transient:表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为
@Transient,否则,ORM框架默认其注解为@Basic。9、
@Basic(fetch=FetchType.LAZY):标记可以指定实体属性的加载方式。10、
@JsonIgnore:作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。11、
@JoinColumn(name=”loginId”):一对一:本表中指向另一个表的外键。一对多:另一个表指向本表的外键。12、
@OneToOne、@OneToMany、@ManyToOne:对应hibernate配置文件中的一对一,一对多,多对一。四、SpringMVC相关注解
1、
@RequestMapping:@RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。
RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性:
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:用在方法的参数前面。
3、
@PathVariable:路径变量。如:
RequestMapping(“user/get/{macAddress}”)
public String
getByMacAddress
(@PathVariable String macAddress){
//do something;
}
参数与大括号里的名字一样要相同。
@ControllerAdvice:包含
@Component。可以被扫描到。统一处理异常。
@ExceptionHandler(Exception.class):用在方法上面表示遇到这个异常就执行以下方法。
来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/69980952/viewspace-2759896/ ,如需转载,请注明出处,否则将追究法律责任。