常用注解的作用及使用方法

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/Andrew_Yuan/article/details/83030537

JPA通过注解或xml描述对象的方法将运行期的实体类持久化到数据库

Jpa是一种规范,而Hibernate是它的一种实现 ;JPA是开源API,如Hiberate就是JPA产品

JPA展示如何将Plain Oriented Java Object(POJO)定义为entity,以及如何管理entity之间的关系。

 

常用注解:

@RequestMapping注解 :是一个用来处理请求地址映射的注解。

@PathVariable 注解:其用来获取请求路径(url )中的动态参数。

@Responsebody注解:表示该方法的返回的结果直接写入 HTTP 响应正文(ResponseBody)中。

@Requestbody注解:将请求体中的参数封装到某个对象中去。

@Transactional注解:一种控制事务管理的快捷手段。

@DateTimeFormat注解:前台以字符串的形式将时间参数传递给后端,后端需要解析成时间格式,即配置pattern=“yyyy/mm/dd即可”。

@Getter和@Setter注解:可以出现在非静态字段和类上,表示使用lombok自动生成getter、setter方法。

@Param注解:参数命名,sql通过该参数名获取值。

 

Request Mapping 基础用法
@RequestMapping 是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径;用于方法上,表示在类的父路径下追加方法上注解中的地址将会访问到该方法,此处需注意@RequestMapping用在类上可以没用,但是用在方法上必须有用。

在 Spring MVC 应用程序中,RequestDispatcher 这个 servlet 负责将进入的 HTTP 请求路由到控制器的处理方法。 在对 Spring MVC 进行的配置的时候, 你需要指定请求与处理方法之间的映射关系。要配置 Web 请求的映射,就需要你用上 @RequestMapping 注解。
@RequestMapping 注解可以在控制器类的级别和/或其中的方法的级别上使用。
在类的级别上的注解会将一个特定请求或者请求模式映射到一个控制器之上。之后你还可以另外添加方法级别的注解来进一步指定到处理方法的映射关系。

 

用 @RequestMapping 处理 HTTP 的方法

Spring MVC 的 @RequestMapping 注解能够处理 HTTP 请求的方法, 比如 GET, PUT, POST, DELETE 以及 PATCH。
所有的请求默认都会是 HTTP GET 类型的。
为了能将一个请求映射到一个特定的 HTTP 方法,你需要在 @RequestMapping 中使用 method 来声明 HTTP 请求所使用的方法类型。如:@RequestMapping(value="/isreasonable/{applyForDate}/{beginDate}/{endDate}",method = RequestMethod.GET)

 

使用 @RequestMapping 处理动态 URI

@RequestMapping 注解可以同 @PathVaraible 注解一起使用,用来处理动态的 URI,URI 的值可以作为控制器中处理方法的参数。跟上述举例的代码一样可以看出。


@Responsebody

@Responsebody注解表示该方法的返回的结果直接写入 HTTP 响应正文(ResponseBody)中,一般在异步获取数据时使用,通常是在使用 @RequestMapping 后,返回值通常解析为跳转路径,加上 @Responsebody 后返回结果不会被解析为跳转路径,而是直接写入HTTP 响应正文中。

作用:

该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。

使用时机:

返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;

 

@RequestBody

@RequestBody 注解则是将 HTTP 请求正文插入方法中,使用适合的 HttpMessageConverter 将请求体写入某个对象。(将请求体重的参数封装到某个对象中去)。

作用:

1) 该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上;
2) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上

使用时机:

A) GET、POST方式提时, 根据request header Content-Type的值来判断:

application/x-www-form-urlencoded, 可选(即非必须,因为这种情况的数据@RequestParam, @ModelAttribute也可以处理,当然@RequestBody也能处理);

multipart/form-data, 不能处理(即使用@RequestBody不能处理这种格式的数据);

其他格式, 必须(其他格式包括application/json, application/xml等。这些格式的数据,必须使用@RequestBody来处理);

 

B) PUT方式提交时,根据request header Content-Type的值来判断: application/x-www-form-urlencoded, 必须;multipart/form-data, 不能处理;其他格式,必须;

说明:request的body部分的数据编码格式由header部分的Content-Type指定;

 

如:

@RequestMapping(value = "user/login")

@ResponseBody

// 将ajax(datas)发出的请求写入 User 对象中

public User login(@RequestBody User user) {

// 这样就不会再被解析为跳转路径,而是直接将user对象写入 HTTP 响应正文中

return user;

}

@Transactional

1)使用前:使用@Transactional的Spring配置,

配置<bean id=“transactionManager”

配置<tx:annotation-driven transaction-manager=“transactionManager”/>,<annotation-driven>标签的声明,则是在Spring内部启用@Transactional来进行事务管理,类似开关之类的声明。

2) @Transactional之value

value这里主要用来指定不同的事务管理器;主要用来满足在同一个系统中,存在不同的事务管理器。比如在Spring中,声明了两种事务管理器txManager1, txManager2.然后,用户可以根据这个参数来根据需要指定特定的txManager。那有同学会问什么情况下会存在多个事务管理器的情况呢? 比如在一个系统中,需要访问多个数据源或者多个数据库,则必然会配置多个事务管理器的。

3)@Transactional之propagation

Propagation支持7种不同的传播机制:

    REQUIRED

               业务方法需要在一个事务中运行,如果方法运行时,已处在一个事务中,那么就加入该事务,否则自己创建一个新的事务.这是spring默认的传播行为.。

     SUPPORTS:  

               如果业务方法在某个事务范围内被调用,则方法成为该事务的一部分,如果业务方法在事务范围外被调用,则方法在没有事务的环境下执行。

     MANDATORY:

               只能在一个已存在事务中执行,业务方法不能发起自己的事务,如果业务方法在没有事务的环境下调用,就抛异常

     REQUIRES_NEW

             业务方法总是会为自己发起一个新的事务,如果方法已运行在一个事务中,则原有事务被挂起,新的事务被创建,直到方法结束,新事务才结束,原先的事务才会恢复执行.

     NOT_SUPPORTED

           声明方法需要事务,如果方法没有关联到一个事务,容器不会为它开启事务.如果方法在一个事务中被调用,该事务会被挂起,在方法调用结束后,原先的事务便会恢复执行.

    NEVER:

              声明方法绝对不能在事务范围内执行,如果方法在某个事务范围内执行,容器就抛异常.只有没关联到事务,才正常执行.

     NESTED:

          如果一个活动的事务存在,则运行在一个嵌套的事务中.如果没有活动的事务,则按REQUIRED属性执行.它使用了一个单独的事务, 这个事务拥有多个可以回滚的保证点.内部事务回滚不会对外部事务造成影响, 它只对DataSourceTransactionManager 事务管理器起效.
NESTED和REQUIRED_NEW两者都是事务嵌套,不同之处在于,内外事务之间是否存在彼此之间的影响;NESTED之间会受到影响,而产生部分回滚,而REQUIRED_NEW则是独立的。

4)rollbackfor

rollbackFor该属性用于设置需要进行回滚的异常类数组,当方法中抛出指定异常数组中的异常时,则进行事务回滚。例如:

指定单一异常类:@Transactional(rollbackFor=RuntimeException.class)

@ApiOperation

首先@ApiOperation注解不是Spring自带的,它是是swagger里的

注解@ApiOperation是用来构建Api文档的

@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response =

“接口返回参数类型”, notes = “接口发布说明”;其他参数可参考源码;

猜你喜欢

转载自blog.csdn.net/Andrew_Yuan/article/details/83030537