RESTEasy配置以及注解

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

        @ApplicationPath("operations")        public class OperationApplication extends Application {        private Set<Object> singletons=new HashSet<Object>();        public OperationApplication(){            singletons.add(new Library());            singletons.add(new BookStoreImpl());        }        @Override        public Set<Object> getSingletons(){            return singletons;        }    }
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

    @Path("/library")    public class Library {        @GET        //@PUT,@POST,@DELETE        @Path("/books")        public String getBooks(){            return "book list";        }     }
1
2
3
4
5
6
7
8
9
10
11

@Path是类与方法级别 
使用@Path注解标识访问路径，该路径基于@ApplicationPath提供的根路径

@GET,@PUT,@DELETE,@POST为方法级别 
这四个注解是http rest注解，用在实际动作上

@PathParam,@QueryParam

···

@PUT@Path("/book/{isbn}")public void addBook(@PathParam("isbn") String isbn, @QueryParam("name") String name){    System.out.println("add the book with name : "+name+", isbn : "+isbn);}@DELETE@Path("/book/{var: .*}/{isbn}")public void removeBook(@PathParam("isbn") String isbn,@PathParam("var") String var){        System.out.println(var);        System.out.println("the book with isbn : "+isbn+" has been removed");    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

···

通过声明@Pathparam参数名可以更方便的获取路径上的参数， 
路径参数可以直接声明，也可以声明后通过正则进行约束，如@Path("/book/{var: .*}/{isbn}")，这里声明了var和isbn两个路径参数，var参数会捕获输入路径中满足冒号后正则的部分作为value

    @POST    @Path("/book{multi}")    public void postBook(@PathParam("multi") PathSegment multi){        MultivaluedMap<String,String> paramMap =multi.getMatrixParameters();        Set<String> set=paramMap.keySet();        for (String key:set){            System.out.println(key+" : "+paramMap.get(key));        }    }
1
2
3
4
5
6
7
8
9
10
11

上一片段对应的请求为：

    POST http://localhost:8080/operations/library/book==;name=EJB 3.0;title=Bill Burke
1
2
3

通过PathSegment类的使用可以将路径参数进行map映射，按照上面的请求写法，会将参数name和title进行键值映射

@MatrixParam

    @PUT    @Path("/books")    public void updateBook(@MatrixParam("name") String name,@MatrixParam("title") String title){        System.out.println("name :"+name+" ,title :"+title);    }
1
2
3
4
5
6

使用@MatrixParam可以获取下面这种资源写法的请求参数：

    GET http://host.com/library/book;name=EJB 3.0;author=Bill Burke
1
2
3

@FormParam,@DefaultValue

    @POST    @Path("/books-form1")    public void addBookByForm(@FormParam("name") @DefaultValue("yimmm") String name,@FormParam("title") String title){        System.out.println("name :"+name+" ,title :"+title);    }
1
2
3
4
5
6
7

作为form提交的参数@FormParam可以根据名称进行获取，@DefaultValue在未传入相应参数时可以赋予其默认值

@Consumes

    @POST    @Path("/books-form2")    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)    public void addBookByForm(MultivaluedMap<String,String> form){        Set<String> set=form.keySet();        for (String key:set){            System.out.println(key+" : "+form.get(key));        }    }
1
2
3
4
5
6
7
8
9
10
11

@Consumes对请求参数格式进行约束 
在进行form提交时，MultivaluedMap

@Form

    @POST    @Path("/books-form3")    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)    public void addBookByForm(@Form Book book){        System.out.println(book.getAuthor());        System.out.println(book.getTitle());    }
1
2
3
4
5
6
7
8

使用@Form可以将form参数直接映射为对象 但是该对象需要进行相关标注。 
新建Book.java，用@FormParam对其进行参数标注，在资源中即可运用@Form在参数列表中对Book book进行标注，请求中的符合Book属性的参数会作为Book实例的属性被接收

    public class Book {    @FormParam("author")    private String author;    @FormParam("title")    private String title;
1
2
3
4
5
6
7

@Context,@Encoded

    @GET    @Path("encodeTest/{name}")    public String testEncode(@Context javax.ws.rs.core.HttpHeaders headers,@PathParam("name") @Encoded String name){        return name;    }
1
2
3
4
5
6
7

@Context在参数列表注入系统级别参数，如上，将javax.ws.rs.core.HttpHeaders进行嵌入。 
@Encoded对当前的pathparam name进行urlencode，接收后的name参数是encode后的字符串

@Produces

    @GET    @Path("/books")    @Produces({MediaType.APPLICATION_JSON,MediaType.TEXT_PLAIN})    public String getBooks(){        return "book list";    }
1
2
3
4
5
6
7

@Produces与@Consumes用法相同，只不过是进行返回数据格式的匹配，它们的参数为字符串数组

---

注：暂且说到这里，后续补充

版权声明：本文为博主原创文章，未经博主允许不得转载。