RESTEasy入门经典

RESTEasy是JBoss的开源项目之一，是一个RESTful Web Services框架。RESTEasy的开发者Bill Burke同时也是JAX-RS的J2EE标准制定者之一。JAX-RS 是一个JCP制订的新标准，用于规范基于HTTP的RESTful Web Services的API。

我们已经有SOAP了，为什么需要Restful WebServices？用Bill自己的话来说："如果是为了构建SOA应用，从技术选型的角度来讲，我相信REST比SOAP更具优势。开发人员会意识到使用传统方式有进行SOA架构有多复杂，更不用提使用这些做出来的接口了。这时他们就会发现Restful Web Services的光明之处。"

说了这么多，我们使用RESTEasy做一个项目玩玩看。首先创造一个maven1的web 项目

Java代码

1.mvn archetype:create -DgroupId=org.bluedash \

2.

3.-DartifactId=try-resteasy -DarchetypeArtifactId=maven-archetype

-webapp

准备工作完成后，我们就可以开始写代码了，假设我们要撰写一个处理客户信息的Web Service，它包含两个功能：一是添加用户信息；二是通过用户Id，获取某个用户的信息，而交互的方式是标准的WebService形式，数据交换格式为XML。假设一条用户包含两个属性：Id和用户名。那么我们设计交换的XML数据如下:

Java代码

1.

2. 1

3. liweinan

4.

首先要做的就是把上述格式转换成XSD2，网上有在线工具可以帮助我们完成这一工作3，在此不详细展开。使用工具转换后，生成如下xsd文件：

Java代码

1.

2.

lt="qualified"

3.version="1.0" xmlns:xsd="https://www.sodocs.net/doc/1d350286.html,/2001/XMLSchema">

4.

5.

6.

7.

8.

9.

10.

11.

有了xsd文件，我们便可以使用JDK自带工具的xjc将xsd转换成为Java的Class。将上述xsd文件存为 user.xsd，并使用如下命令进行转换：

Java代码

1.xjc user.xsd

执行结束后我们会得到一系列的类文件：

Java代码

1.Li-Weinans-MacBook-Pro:Desktop liweinan$ xjc user.xsd

2.parsing a schema...

https://www.sodocs.net/doc/1d350286.html,piling a schema...

4.generated/ObjectFactory.java

5.generated/UserType.java

这样，我们的XML格式的交换数据便转化为面向对像的Java类了，是不是感觉有点像Hibernate的ORM理念？没错，将XML映射成成面向对象的数据类，这个过程叫做XML Binding，即XML绑定。这个过程也有J2EE标准，叫做JAXB4。而RESTEasy是全面支持JAXB的。可以说RESTEasy所支持的JAX-RS标准，当与JAXB 标准结合在一起使用时，就可以发挥出最大优势，让程序员少写一堆一堆的代码。有关JAXB标准，会在独立的篇章中详细讨论，在此先不展开。总之我们将生成的Java类放进项目中等候使用。我们可以看一下UserType类的内容：

Java代码

1.package org.bluedash.resteasy;

2.

3.import javax.xml.bind.annotation.XmlAccessType;

4.import javax.xml.bind.annotation.XmlAccessorType;

5.import javax.xml.bind.annotation.XmlElement;

6.import javax.xml.bind.annotation.XmlType;

7.

8.@XmlAccessorType(XmlAccessType.FIELD)

9.@XmlType(name = "userType", propOrder = {

10. "id",

11. "name"

12.})

13.public class UserType {

14.

15. protected int id;

16. @XmlElement(required = true)

17. protected String name;

18.

19. /**

20. * Gets the value of the id property.

21. *

22. */

23. public int getId() {

24. return id;

25. }

26.

27. /**

28. * Sets the value of the id property.

29. *

30. */

31. public void setId(int value) {

32. this.id = value;

33. }

34.

35. /**

36. * Gets the value of the name property.

37. *

38. * @return

39. * possible object is

40. * {@link String }

41. *

42. */

43. public String getName() {

44. return name;

45. }

46.

47. /**

48. * Sets the value of the name property.

49. *

50. * @param value

51. * allowed object is

52. * {@link String }

53. *

54. */

55. public void setName(String value) {

56. https://www.sodocs.net/doc/1d350286.html, = value;

57. }

58.

59.}

可以看到，XML格式就是通过一些JAXB的标记被映射成了Java类。我们没写什么代码，已经把数据模型定义清楚了。接下来我们撰写最核心的WebService API。我们的WebService包含两个接口：一个是添加用户接口createUser，另一个是获取用户接口getUser：

Java代码

1.package org.bluedash.resteasy;

2.

3.import https://www.sodocs.net/doc/1d350286.html,.URI;

4.import java.util.Map;

5.import java.util.concurrent.ConcurrentHashMap;

6.import java.util.concurrent.atomic.AtomicInteger;

7.

8.import javax.ws.rs.Consumes;

9.import javax.ws.rs.GET;

10.import javax.ws.rs.POST;

11.import javax.ws.rs.Path;

12.import javax.ws.rs.PathParam;

13.import javax.ws.rs.Produces;

14.import javax.ws.rs.WebApplicationException;

15.import javax.ws.rs.core.Response;

16.

17.@Path("/users")

18.public class UserServlet {

19.

20. private Map userStore =

21. new ConcurrentHashMap();

22. private AtomicInteger idGenerator = new AtomicInteger();

23.

24. @POST

25. @Consumes("application/xml")

26. public Response createUser(UserType user) {

27. user.setId(idGenerator.incrementAndGet());

28. userStore.put(user.getId(), user);

29. System.out.println(user.getName() + " created: "

30. + user.getId());

31. return Response.created(URI.create("/users/"

32. + user.getId())).build();

33. }

34.

35. @GET

36. @Path("{id}")

37. @Produces("application/xml")

38. public UserType getUser(@PathParam("id") int id) {

39. UserType u = userStore.get(id);

40. if (u == null) {

41. throw new WebApplicationException(

42. Response.Status.NOT_FOUND);

43. }

44. return u;

45. }

46.

47.}

用几个简单的JAX-RS标记，便把普通的函数变成了WebService接口。而这些标记将由RESTEasy支持生效。接下来我们将要进行RESTEasy的配置工作。RESTEasy 的配置方法有多种多样，可以和Spring等容器集成，也可以独立运行，因为我们用的Servlet的形式使RESTEasy进行工作，这也是最主流的方式，因此在这里使用web容器来加载它，首先定义一个配置类:

Java代码

1.package org.bluedash.resteasy;

2.

3.import java.util.HashSet;

4.import java.util.Set;

5.

6.import javax.ws.rs.core.Application;

7.

8.public class BluedashResteasyApplication extends Application {

9. private Set