RESTEasy
近期在学习RESTful设计模式,但是看得云里雾里,于是找了这个运用该模式的接口规范来配合学习,效果不错。
常用注解
RESTEasy以jaxrs-api.jar包为基础对JAX-RS进行实现,该包中包含了JAX-RS规范所声明的注解。
注解列表
这里我们根据3.0.7.Final这一版本对一些常用注解进行说明,以下是注解列表,请进行参考阅读:
注解 | 描述 | 参数 |
---|---|---|
@ApplicationPath | 标注资源的root路径,加载子资源文件 | value |
@Path | 标注普通资源路径 | value |
@GET | 获取 | |
@POST | 添加 | |
@PUT | 整体更新 | |
@PATCH | 部分更新(resteasy中并没有) | |
@DELETE | 删除 | |
@PathParam | 资源路径参数 | value |
@QueryParam | 资源请求参数 | value |
@MatrixParam | 标注请求资源key-value类型的参数 | value |
@FormParam | 标注表单参数 | value |
@Encoded | 标注需要UrlEncode的元素 | |
@Context | 在参数列表注入系统级别参数javax.ws.rs.core.HttpHeaders, javax.ws.rs.core.UriInfo, javax.ws.rs.core.Request, javax.servlet.HttpServletRequest, javax.servlet.HttpServletResponse, javax.servlet.ServletConfig, javax.servlet.ServletContext, and javax.ws.rs.core.SecurityContext objects | |
@CookieParam | 标注需要获取的cookie参数 | value |
@Consumes | 指定client请求数据类型,与client的Content-Type匹配 | value[] |
@Produces | 指定client接收数据类型,与client的Accept匹配 | value[] |
@HeaderParam | 标注需要获取的header参数 | value |
@DefaultValue | 标注默认值 | value |
@Form | 标注表单对象,对象中的表单属性需要@FormParam进行标注 |
使用方法
@ApplicationPath
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
在使用RESTEasy进行应用启动的时候,需要指明其请求根路径,这里既需要用到@ApplicationPath
注解。
新建一个资源处理类OperationApplication继承Application,
标注类级别注解@ApplicationPath
,用以声明根路径,
重写getSingletons()方法,用以获取资源容器
在构造器中加载Library和BookStoreImpl两份资源,只有在此添加的资源才能被访问
@Path,@GET,@PUT,@DELETE,@POST
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
@Path是类与方法级别
使用@Path
注解标识访问路径,该路径基于@ApplicationPath
提供的根路径
@GET,@PUT,@DELETE,@POST为方法级别
这四个注解是http rest注解,用在实际动作上
@PathParam,@QueryParam
···
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
···
通过声明@Pathparam
参数名可以更方便的获取路径上的参数,
路径参数可以直接声明,也可以声明后通过正则进行约束,如@Path("/book/{var: .*}/{isbn}")
,这里声明了var和isbn两个路径参数,var参数会捕获输入路径中满足冒号后正则的部分作为value
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
上一片段对应的请求为:
- 1
- 2
- 3
通过PathSegment类的使用可以将路径参数进行map映射,按照上面的请求写法,会将参数name和title进行键值映射
@MatrixParam
- 1
- 2
- 3
- 4
- 5
- 6
使用@MatrixParam可以获取下面这种资源写法的请求参数:
- 1
- 2
- 3
@FormParam,@DefaultValue
- 1
- 2
- 3
- 4
- 5
- 6
- 7
作为form提交的参数@FormParam
可以根据名称进行获取,@DefaultValue
在未传入相应参数时可以赋予其默认值
@Consumes
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
@Consumes
对请求参数格式进行约束
在进行form提交时,MultivaluedMap
@Form
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
使用@Form
可以将form参数直接映射为对象 但是该对象需要进行相关标注。
新建Book.java,用@FormParam对其进行参数标注
,在资源中即可运用@Form
在参数列表中对Book book
进行标注,请求中的符合Book属性的参数会作为Book实例的属性被接收
- 1
- 2
- 3
- 4
- 5
- 6
- 7
@Context,@Encoded
- 1
- 2
- 3
- 4
- 5
- 6
- 7
@Context在参数列表注入系统级别参数,如上,将javax.ws.rs.core.HttpHeaders进行嵌入。
@Encoded对当前的pathparam name进行urlencode,接收后的name参数是encode后的字符串
@Produces
- 1
- 2
- 3
- 4
- 5
- 6
- 7
@Produces与@Consumes用法相同,只不过是进行返回数据格式的匹配,它们的参数为字符串数组
注:暂且说到这里,后续补充