当前位置: 首页 > 科技观察

SpringBoot注解全集,一键收藏!

时间:2023-03-18 22:06:38 科技观察

1、注解列表@SpringBootApplication:包含@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让springBoot扫描到Configuration类,并添加到程序上下文中。@Configuration相当于spring的XML配置文件;使用Java代码可以检查类型安全。@EnableAutoConfiguration自动配置。@ComponentScan组件扫描可以自动发现和组装一些bean。@Component可以和CommandLineRunner一起使用,在程序启动后执行一些基本任务。@RestController注解是@Controller和@ResponseBody的集合,表示这是一个controllerbean,函数的返回值直接填充在HTTP响应体中,是一个REST风格的controller。@Autowired自动导入。@PathVariable获取参数。@JsonBackReference解决了嵌套外部链接的问题。@RepositoryRestResourcepublic与spring-boot-starter-data-rest一起使用。2.详细注解(annotations)@SpringBootApplication:声明让springboot根据需要自动配置程序。该配置相当于:@Configuration、@EnableAutoConfiguration和@ComponentScan三个配置。packagecom.example.myproject;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication//sameas@Configuration@EnableAutoConfiguration@ComponentScanpublicclassApplication{publicstaticvoidmain(String[]args){SpringApplication.run(应用类,args);}}@ResponseBody:表示该方法的返回结果直接写入HTTP响应体,一般在异步获取数据时使用,用于构建RESTfulAPI。使用@RequestMapping后,返回值通常被解析为跳转路径。添加@responsebody后,返回结果不会被解析为跳转路径,而是直接写入HTTP响应体。比如异步获取json数据,添加@responsebody后,直接返回json数据。该注解一般与@RequestMapping一起使用。示例代码:@RequestMapping(“/test”)@ResponseBodypublicStringtest(){return”ok”;}@Controller:用于定义controller类,在spring项目中,controller负责转发用户发送的URL请求对相应的服务接口(服务层)一般在类中进行注解,通常方法需要使用@RequestMapping进行注解。示例代码:@Controller@RequestMapping(“/demoInfo”)publicclassDemoController{@AutowiredprivateDemoInfoServicedemoInfoService;@RequestMapping("/hello")publicStringhello(Mapmap){System.out.println("DemoController.hello()");map.put("hello","fromTemplateController.helloHtml");//hello.html或者hello.ftl模板将用于渲染和显示。return"/hello";}}@RestController:用于标记控制层组件(如struts中的action),@ResponseBody和@Controller的集合。示例代码:packagecom.kfit.demo.web;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.bind.annotation.RestController;@RestController@RequestMapping(“/demoInfo2”)publicclassDemoController2{@RequestMapping("/test")publicStringtest(){return"ok";}}@RequestMapping:提供路由信息,负责将URL映射到Controller中的具体功能。@EnableAutoConfiguration:SpringBoot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的类路径中存在HSQLDB,而你没有手动配置任何数据库连接bean,那么我们会自动配置一个内存数据库。你可以在@Configuration类中添加@EnableAutoConfiguration或@SpringBootApplication注解来选择自动配置.如果你发现应用了一个你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的exclusion属性来禁用它们@ComponentScan:表示该类将被自动发现并扫描组件。个人理解相当于,如果扫描带有@Component、@Controller、@Service等注解的类并注册为Bean,就可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解来搜索bean和结合@Autowired注解导入,所有Spring组件都可以收集起来自动,包括@Configuration类。如果没有配置,SpringBoot会扫描启动类所在包下的类,以及使用@Service、@Repository等注解的子包。@Configuration:等价于传统的xml配置文件,如果某些第三方库需要使用xml文件,建议使用@Configuration类作为项目的主要配置类——可以使用@ImportResource注解加载xml配置文件。@Import:用于导入其他配置类。@ImportResource:用于加载xml配置文件。@Autowired:自动导入依赖bean@Service:一般用于修改服务层的组件@Repository:使用@Repository注解可以保证DAO或repositories提供异常翻译。该注解修改后的DAO或repositories类会被ComponentScan发现并配置,不需要为它们提供XML配置项。@Bean:@Bean注解方法相当于在XML中配置的bean。@Value:注入到Springbootapplication.properties配置中的属性的值。示例代码:@Value(value="#{message}")privateStringmessage;@Inject:等价于默认的@Autowired,但没有required属性;@Component:泛指组件。当组件不容易归类时,我们可以使用这个注解进行注解。@Bean:相当于XML中的,放在方法上面,而不是类上面,意思是生成一个bean,交给spring管理。@AutoWired:自动导入依赖bean。按类型方法。使用配置好的Bean完成属性和方法的组装。它可以标记类成员变量、方法和构造函数来完成自动装配的工作。添加(required=false)时,即使找不到bean也不会报错。@Qualifier:当有多个相同类型的bean时,可以使用@Qualifier("name")来指定。与@Autowired配合使用效果很好。@Qualifier限定描述符除了可以根据名称进行注入外,还可以对如何选择候选者进行更细粒度的控制。具体用法如下:@Autowired@Qualifier(value="demoInfoService")privateDemoInfoServicedemoInfoService;@Resource(name="name",type="type"):如果括号内没有内容,则默认为byName。做一些类似于@Autowired的事情。3、JPA注解@Entity:@Table(name=""):表示这是一个实体类。一般用于jpa,这两个注解一般一起使用,但是如果表名和实体类名相同,@Table可以省略@MappedSuperClass:用在确定为父类的实体上。父类的属性可以被子类继承。@NoRepositoryBean:一般用作父类的repository,加上这个注解,spring不会实例化repository。@Column:字段名与列名相同时可以省略。@Id:表示该属性为主键。@GeneratedValue(strategy=GenerationType.SEQUENCE,generator="repair_seq"):表示主键生成策略是sequence(可以是Auto,IDENTITY,native等,Auto表示在多个数据库之间切换),名称指定的序列是repair_seq。@SequenceGeneretor(name="repair_seq",sequenceName="seq_repair",allocationSize=1):name是序列的名字,方便使用,sequenceName是数据库的序列名,两个名字可以相同。@Transient:表示该属性不是数据库表中字段的映射,ORM框架会忽略该属性。如果属性不是数据库表的字段映射,则必须标记为@Transient,否则ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY):该标签可以指定实体属性的加载方式@JsonIgnore:作用是在json序列化时忽略Javabean中的一些属性,序列化和反序列化都会受到影响。@JoinColumn(name="loginId"):一对一:一个外键指向本表中的另一个表。一对多:另一个表指向这个表的外键。@OneToOne、@OneToMany、@ManyToOne:分别对应hibernate配置文件中的一对一、一对多、多对一。4.SpringMVC相关注释@RequestMapping:@RequestMapping("/path")表示控制器处理所有"/path"的URL请求。RequestMapping是用来处理请求地址映射的注解,可以用在类或方法上。它用在一个类上,表示该类中所有响应请求的方法都使用这个地址作为父路径。该注解有六个属性:params:指定请求必须包含一定的参数值,方法才能对其进行处理。headers:指定请求必须包含某些指定的标头值,以便方法处理请求。value:指定请求的实际地址,指定的地址可以是一个URITemplate模式method:指定请求的方法类型,GET、POST、PUT、DELETE等consumers:指定提交的内容类型(Content-Type)用于处理请求,如application/json,text/html;produces:指定返回的内容类型,只有当请求头中的(Accept)类型包含指定类型时才返回。@RequestParam:用在方法的参数前面。@RequestParamStringa=请求。获取参数(“一个”)。@PathVariable:路径变量。例如RequestMapping("user/get/mac/{macAddress}")publicStringgetByMacAddress(@PathVariableStringmacAddress){//dosomething;}参数必须与大括号中的名称相同。5、全局异常处理@ControllerAdvice:包含@Component。可以扫描。统一处理异常。@ExceptionHandler(Exception.class):用在方法上,表示遇到这个异常时执行下面的方法。