webservice常用注解总结

最新推荐文章于 2024-11-21 14:58:01 发布

原创最新推荐文章于 2024-11-21 14:58:01 发布 · 3.9k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#web service #annotation #注解

Java 专栏收录该内容

23 篇文章

订阅专栏

本文详细介绍了RESTful API中常见的HTTP方法及其对应的操作，包括查询、插入、更新和删除数据的具体应用，并解释了如何通过不同注解来实现这些操作。

                    
                        
                    
                    Annotation作用说明
@GET查询请求相当于数据库的查询数据操作
@POST插入请求相当于数据库的插入数据操作
@PUT更新请求相当于数据库的更新数据操作
@DELETE删除请求相当于数据的删除数据操作
@Pathuri路径定义资源的访问路径，client通过这个路径访问资源。比如：@Path(“user”)
@Produces指定返回MIME格式资源按照那种数据格式返回，可取的值有：MediaType.APPLICATION_XXX。比如：@Produces(MediaType.APPLICATION_XML)
@Consumes接受指定的MIME格式只有符合这个参数设置的请求再能访问到这个资源。比如@Consumes(“application/x-www-form-urlencoded”)
@PathParamuri路径参数写在方法的参数中，获得请求路径参数。比如：@PathParam(“username”)  String userName
@QueryParamuri路径请求参数写在方法的参数中，获得请求路径附带的参数。比如：@QueryParam(“desc”)  String desc
@DefaultValue设置@QueryParam参数的默认值如果@QueryParam没有接收到值，就使用默认值。比如：@DefaultValue(“description”) @QueryParam(“desc”) String desc
@FormParamform传递的参数接受form传递过来的参数。比如：@FormParam(“name”)  String userName
@BeanParam通过Bena的形式传递参数接受client传递的bean类型的参数，同时这个bean可以在属性上配置@FormParam用以解决client的属性名称和bean的属性名称不一致的问题。比如：@BeanParam  User user
@Context获得一些系统环境信息通过@Context可以获得以下信息：UriInfo、ServletConfig、ServletContext、HttpServletRequest、HttpServletResponse和HttpHeaders等
@XmlRootElement将bean转换为xml如果要讲bean以xml或json的格式返回，必须要这个注解。比如：@XmlRootElementpublic class User｛…｝
@XmlElements
@XmlElement

                

Annotation	作用	说明
@GET	查询请求	相当于数据库的查询数据操作
@POST	插入请求	相当于数据库的插入数据操作
@PUT	更新请求	相当于数据库的更新数据操作
@DELETE	删除请求	相当于数据的删除数据操作
@Path	uri路径	定义资源的访问路径，client通过这个路径访问资源。比如：@Path(“user”)
@Produces	指定返回MIME格式	资源按照那种数据格式返回，可取的值有：MediaType.APPLICATION_XXX。比如：@Produces(MediaType.APPLICATION_XML)
@Consumes	接受指定的MIME格式	只有符合这个参数设置的请求再能访问到这个资源。比如@Consumes(“application/x-www-form-urlencoded”)
@PathParam	uri路径参数	写在方法的参数中，获得请求路径参数。比如：@PathParam(“username”) String userName
@QueryParam	uri路径请求参数	写在方法的参数中，获得请求路径附带的参数。比如：@QueryParam(“desc”) String desc
@DefaultValue	设置@QueryParam参数的默认值	如果@QueryParam没有接收到值，就使用默认值。比如：@DefaultValue(“description”) @QueryParam(“desc”) String desc
@FormParam	form传递的参数	接受form传递过来的参数。比如：@FormParam(“name”) String userName
@BeanParam	通过Bena的形式传递参数	接受client传递的bean类型的参数，同时这个bean可以在属性上配置@FormParam用以解决client的属性名称和bean的属性名称不一致的问题。比如：@BeanParam User user
@Context	获得一些系统环境信息	通过@Context可以获得以下信息：UriInfo、ServletConfig、ServletContext、HttpServletRequest、HttpServletResponse和HttpHeaders等
@XmlRootElement	将bean转换为xml	如果要讲bean以xml或json的格式返回，必须要这个注解。比如：@XmlRootElementpublic class User｛…｝
@XmlElements
@XmlElement