美文网首页
springboot常用注解

springboot常用注解

作者: jiahzhon | 来源:发表于2020-03-27 17:13 被阅读0次

@SpringBootApplication

包含@Configuration@EnableAutoConfiguration@ComponentScan通常用在主类上。

  • @Configuration
    • 指出该类是Bean配置的信息源,相当于XML中的<beans></beans>
  • @EnableAutoConfiguration
    • 让SpringBoot根据应用所声明的依赖来对Spring框架进行自动配置,一般加在主类上。
  • @ComponentScan
    • 组件扫描,相当于<contest:component-scan>如果扫描到有@Component @Controller @Service等这些注解的类,则把这些类注册为bean。

@Component

  • 泛指组件,当组件不好归类的时候,可以使用这个注解。

@Profile

  • Profiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。任何@Component或者@Configuration都能被@profile标记,从而限制加载它的时机。

@Repository

  • 用于标注数据访问组件,即DAO组件。
  • @Controller 注解的bean会被spring-mvc框架所使用。
  • @Repository 会被作为持久层操作(数据库)的bean来使用。

@Mapper

  • 作用:在接口类上添加了@Mapper,在编译之后会生成相应的接口实现类
  • 添加位置:接口类上面
@Mapper
public interface UserDAO {
   //代码
}

@MapperScan

  • 作用:指定要变成实现类的接口所在的包,然后包下面的所有接口在编译之后都会生成相应的实现类
  • 被扫的包底下就没有必要每个都去写写@Mapper了。

@Mapper和@Repository的区别

  • @Repository需要在Spring中配置扫描地址,然后生成Dao层的Bean才能被注入到Service层中。(一定要使用@MapperScan("xxx.xxx.xxx.mapper")进行扫描)
  • @Mapper不需要配置扫描地址,通过xml里面的namespace里面的接口地址,生成了Bean后注入到Service层中。
  • 一般现在用@MapperScan一个搞定。

@Service

  • 用于标注业务层组件。

@RestController

用于标注控制层组件,包含@Controller@ResponseBody

  • @ResponseBody
    • 将controller的方法返回的对象通过适当的转换器转换为指定的格式之后,写入到response对象的body区,通常用来返回JSON数据或者是XML数据。
    • 在使用此注解之后不会再走视图处理器,而是直接将数据写入到输入流中,他的效果等同于通过response对象输出指定格式的数据。
    • 将java对象转为json格式的数据。如果没写,前端接收到的是Object类型。

@RequestMapping

  • 一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性。
    • params:指定request中必须包含某些参数,才让该方法处理。
    • value:指定请求的实际地址。
    • method:指定请求的method类型,GET、POST、PUT、DELETE。
    • comsume:指定处理请求的提交内容类型(Content-type),如application/json,text/html。
    • headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
//仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/”的请求;
@RequestMapping(value = "/list" , method = RequestMethod.POST,headers="Referer=http://www.ifeng.com/")
public JSONObject list(@PathVariable String communityId) {
   JSONObject object = new JSONObject();
   object.put("communityId",communityId);
   return object;
}

@RequestBody

  • @RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的);
  • GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交。
  • 在后端的同一个接收方法里,@RequestBody与@RequestParam()可以同时使用,@RequestBody最多只能有一个,而@RequestParam()可以有多个。
  • 当同时使用@RequestParam()和@RequestBody时,@RequestParam()指定的参数可以是普通元素、数组、集合、对象等等(即:当,@RequestBody 与@RequestParam()可以同时使用时,原SpringMVC接收参数的机制不变,只不过RequestBody 接收的是请求体里面的数据;而RequestParam接收的是key-value里面的参数,所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。

@RequestParam

  • 用在方法的参数前面。@RequestParam
    @RequestParam(value=”参数名”, required=true/false, defaultValue=” ”)

@PathVariable

  • 路径变量。参数与大括号的名字要相同
RequestMapping(“user/get/mac/{macAddress}”)
public String getByMacAddress(@PathVariable String macAddress){
}

@Bean

  • 相当于xml中的<bean></bean>,放在方法上面,而不是类,意思是产生一个bean,并且交给spring管理。

@AutoWired

  • byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量,方法及构造函数进行标注,完成自动装配的工作。(required = false 拿不到bean不报错)。
  • @Autowired 默认是按照类去匹配,配合 @Qualifier 指定按照名称去装配 bean。

@Qualifier

  • 当有多个同一类型的Bean时,可以用@Qualifier("name")来之指定,与@Autowired配合使用。

@Resource(name="name",type="type")

  • 没有括号内内容的话,默认byname,与@Autowired干类似的事。

相关文章

网友评论

      本文标题:springboot常用注解

      本文链接:https://www.haomeiwen.com/subject/vjcruhtx.html