发布于 2016-07-21 21:06:47 | 949 次阅读 | 评论: 0 | 来源: 网友投递
RESTful
REST(英文:Representational State Transfer,简称REST)描述了一个架构样式的网络系统,比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中,他是 HTTP 规范的主要编写者之一。在目前主流的三种Web服务交互方案中,REST相比于SOAP(Simple Object Access protocol,简单对象访问协议)以及XML-RPC更加简单明了,无论是对URL的处理还是对Payload的编码,REST都倾向于用更加简单轻量的方法设计和实现。值得注意的是REST并没有一个明确的标准,而更像是一种设计的风格。
RESTful 一种软件架构风格,设计风格而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。
需要传递数组参数的情况,如果是一般的form表单,可以直接定义参数类型为List<String>即可(不能定义为数组类型,否则只能得到一个null)。
示例代码如下:
@POST
@Path("/user" )
public Response createUser(@FormParam("username" ) String username,
@FormParam( "keyword") List<String> keywords) {
文件上传接口如何传递 数据 参数?
但是如果是上传文件的接口,因为使用了 @FormDataParam 注解,则不能使用上述用法:
@POST
@Path("/upload" )
@Consumes(MediaType.MULTIPART_FORM_DATA )
public Response uploadFile(@FormDataParam ("filename" ) String filename,
@FormDataParam( "file") InputStream uploadedInputStream,
@FormDataParam( "file") FormDataContentDisposition fileDetail ,
@FormDataParam( "keyword") final List<String> keywords) {
访问这个接口时会发生异常:
java.lang.IllegalArgumentException : wrong number of arguments
可见使用 @FormDataParam 注解时,将参数类型定义成List<String>是不行的,可以定义成 List<FormDataBodyPart> ,从 FormDataBodyPart对象中可以取得参数:
@POST
@Path("/upload" )
@Consumes(MediaType.MULTIPART_FORM_DATA )
public Response uploadFile(@FormDataParam("filename" ) String filename,
@FormDataParam( "file") InputStream uploadedInputStream,
@FormDataParam( "file") FormDataContentDisposition fileDetail ,
@FormDataParam( "keyword") final List<FormDataBodyPart> keywordObjs ) {
if (keywordObjs != null && ! keywordObjs.isEmpty()) {
for (FormDataBodyPart keywordObj : keywordObjs) {
String keyword = keywordObj.getValueAs(String.class);
System. out.println( "关键字:" + keyword );
}
}
RESTful 注解大全
@GET、@POST、@PUT、@DELETE、@HEAD
@GET、@POST、@PUT、@DELETE 以及 @HEAD 均是 HTTP 请求方法指示符注释。您可以使用它们来绑定根资源或子资源内的 Java 方法与 HTTP 请求方法。HTTP GET 请求被映射到由 @GET 注释的方法;HTTP POST 请求被映射到由 @POST 注释的方法,以此类推。
@Conumes 和 @Produces
@Conumes注释代表的是一个资源可以接受的MIME类型。@Produces注释代表的是一个资源可以返回的MIME类型。
@Path
@Path注释被用来描述根资源、子资源方法或子资源位置。value值可以包含文本字符、变量或具有定制正则表达式的变量。