名词解释
REST(Representational State Transfer 表述性状态转移) 一种跨平台跨语言的架构风格
REST式的Web服务 是REST在Web领域的实现
JAX-RS 是REST在java领域的标准
Jersey 是JAX-RS标准的参考实现
REST资源地址设计
| 功能 | 请求类型 | 资源地址 |
| 添加/创建 | POST |
/books |
| PUT | /books/{id} | |
| 删除 | DELETE | /books/{id} |
| 修改/更新 | PUT | /books/{id} |
| 查询全部 | GET | /books |
| 查询主键 | GET | /bookars/{id} |
| GET | /books?id=12345 | |
| 分页作用查询 | GET | /books?start=0&size=10 |
| GET | /books/01,2002-12,2014 | |
| GET | /books/restful;grogram=java;type=web | |
| GET | /books?limit=10&sort=bookname |
pom文件如下：
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.haha</groupId> <artifactId>rest_test</artifactId> <packaging>war</packaging> <version>1.0-0</version> <build> <finalName>rest_test</finalName> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>2.5.1</version> <inherited>true</inherited> <configuration> <source>1.7</source> <target>1.7</target> </configuration> </plugin> </plugins> </build> <dependencyManagement> <dependencies> <dependency> <groupId>org.glassfish.jersey</groupId> <artifactId>jersey-bom</artifactId> <version>2.19</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.glassfish.jersey.containers</groupId> <artifactId>jersey-container-servlet-core</artifactId> </dependency> <dependency> <groupId>org.glassfish.jersey.media</groupId> <artifactId>jersey-media-moxy</artifactId> </dependency> <dependency> <groupId>org.glassfish.jersey.media</groupId> <artifactId>jersey-media-json-jackson</artifactId> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.7.0</version> </dependency> </dependencies> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> </project>
核心启动类如下：
package my.test;
import org.glassfish.jersey.server.ResourceConfig;
public class RestBootstrap extends ResourceConfig {
public RestBootstrap() {
packages("com.haha");
}
}
注解汇总
@GET，@PUT，@POST，@DELETE，标注方法是用的HTTP请求的类型
@GET ： 提供查询方法，所有参数均在URL路径中，只能传输一个或者多个字符串，无法传输对象
@POST：提供新增方法，参数可以存在URL路径中，也可以存在BODY中。
如传输文本格式的参数，使用String类型或者基本数据类型；
如传输JSON格式的参数，使用map、list或者对象。
@PUT ： 提供修改方法
@DELETE：提供删除方法
@Produces，标注返回的MIME媒体类型
处理返回中文乱码：@Produces("text/plain; charset=utf-8")
@Consumes，标注可接受请求的MIME媒体类型
标记Http请求不同位置：
@PathParam，@QueryParam，@HeaderParam，@CookieParam，@MatrixParam，@FormParam
@PathParam：提取URL模版路径中的参数
核心类如下：
package com.haha;
import java.io.IOException;
import java.util.List;
import java.util.TimeZone;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.MatrixParam;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
@Path("/test")
public class TestRest {
@GET
@Path("/simple")
@Produces(MediaType.TEXT_PLAIN)
@Consumes(MediaType.TEXT_PLAIN)
public Response go() {
System.out.println("hello");
return Response.ok().entity("{\"aaa\":\"bbb\"}").build();
}
/**
* @Path中的值可以为具体值，也可以是正则表达式
* 这里是/path-param-{id}，通过@PathParam注解可以提取path路径中的id
* 假设请求的URL为
* http://localhost:8080/rest/path-param-1234
* @PathParam 解析出来的id就是12345
* @param id
* @return
*/
@POST
@Path("/path-param-{id}")
@Consumes(MediaType.TEXT_PLAIN)
@Produces(MediaType.TEXT_PLAIN)
public String getPathParam(@PathParam(value = "id") int id) {
return "输入的id-->"+id;
}
/**
* 假设请求的URL为
* http://localhost:8080/rest/path-param?id=12345
* 解析出来的id就是1234
* @param id
* @return
*/
@PUT
@Path("/path-param")
@Consumes(MediaType.TEXT_PLAIN)
@Produces(MediaType.TEXT_PLAIN)
public String getQueryParam(@QueryParam(value = "id") String id) {
return "请求参数id-->"+id;
}
/**
* 假设URL为
* http://localhost:8080/test/test--context;color=balck
* @MatrixParam 可以识别 PathParam识别不了的参数
* @param color
* @param year
* @param model
* @return
*/
@GET
@Path("{model}--{year}")
@Consumes(MediaType.TEXT_PLAIN)
@Produces(MediaType.TEXT_PLAIN)
public String getMatrixParam(@MatrixParam(value = "color") String color,
@PathParam(value = "year") String year,
@PathParam(value = "model") String model) {
return "color: " + color + "; year: " + year + "; model: " + model;
}
/**
* 功能描述: (Context获取Path路径,Matrix参数,PathParam参数)
* http://localhost:8080/test/test-context/123;color=balack
* @param uriInfo
* @return
*/
@GET
@Path("test-context/{id}")
@Consumes(MediaType.TEXT_PLAIN)
@Produces(MediaType.TEXT_PLAIN)
public String getContext(@Context UriInfo uriInfo) {
String path = uriInfo.getPath();
List<PathSegment> lsps = uriInfo.getPathSegments();
String psString = "";
for (PathSegment ps : lsps) {
psString = psString + toJsonString(ps)+ "; ";
}
MultivaluedMap<String, String> map = uriInfo.getPathParameters();
return "path:" + path + "; lsps:" + psString + "; map:" + toJsonString(map);
}
/**
* @HeaderParam 从请求头中取值
* @CookieParam 和 @FormParam 不清楚如何使用
* @param myhead
* @param mycookie
* @param myform
* @return
*/
@DELETE
@Path("/other")
@Consumes(MediaType.TEXT_PLAIN)
@Produces(MediaType.TEXT_PLAIN)
public String other(@HeaderParam("myhead") String myhead) {
return "myhead-->"+myhead;
}
/**
* 生成json格式数据
* @param obj
* @return
*/
public static String toJsonString(Object obj) {
return toJsonString(obj,false);
}
/**
* 将对象类型转换为json格式数据
* @param obj
* @param ignoreNullField
* @return
*/
public static String toJsonString(Object obj, boolean ignoreNullField) {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8:00"));
if (ignoreNullField)
objectMapper.setSerializationInclusion(Include.NON_NULL);
try {
return objectMapper.writeValueAsString(obj);
} catch (IOException e) {
e.printStackTrace();
return null;
}
}
}
REST安全.
1.基本认证 BASE认证
2.摘要认证 RSA散列加密
3.表单认证
4.证书认证
5.Oauth认证
服务器--浏览器通讯
1.Polling技术
客户端主动向服务端拉数据，容易实现技术可插拔，但是效率不行
2.Comet技术
反向Ajax技术，相当于服务端主主动向客户端拉数据，效率高，但需要服务端装扩展插件
3.SSE技术
HTML5的标准，服务端可以主动推数据到客户端，缺点是客户端无法向服务端获取数据
4.WebSocket
HTML5的标准，客户端和服务端可以双向通讯，但实现较为复杂
参考
Java Restful Web Services （二）——参数注解1
相关推荐
**Rest简介** REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，主要用于Web服务的构建。RESTful架构强调无状态、客户端-服务器架构、统一接口等原则，使得系统更加...
使用 ASP.NET Core 3.x 构建 RESTful Web API（2020-2-7更新） P1_准备工作_P2_REST简介_P3_API对外合约_Routine.Api2020_2_5.rar Representational State Transfer(状态表述转换)
#### 一、REST简介与背景 - **REST (Representational State Transfer)**：一种软件架构风格，用于描述基于网络的应用程序如何工作。REST的核心理念是通过简单的HTTP方法（如GET、POST、PUT、DELETE等）来操作资源...
#### 二、HTTP REST简介 REST (Representational State Transfer) 是一种设计网络应用程序的架构风格，其核心原则之一是无状态性。在REST架构中，客户端和服务端之间的交互基于HTTP协议，通过发送HTTP请求并接收...
#### REST简介与核心价值 在《深入浅出REST》这篇文章中，作者Stefan Tilkov通过清晰且易于理解的方式介绍了REST（表述性状态转移）这一概念及其在现代软件架构中的应用。随着互联网技术的发展，REST作为一种轻量级...
1、REST简介 REST简介 REST风格简介 2、RESTful入门案例 入门案例 请求方法设定 请求路径参数 3、REST快速开发 RESTful快速开发（标准开发） @RestController 标准请求动作映射（4种） 4、案例：基于RESTful页面...
#### 一、REST简介 REST（Representational State Transfer）代表状态传输，这是一种分布式超媒体系统的架构风格。它最初由Roy Fielding在其博士论文中定义，旨在为网络应用的设计和开发提供一套指导原则，以降低...
REST 简介 REST 是英文 Representational State Transfer 的缩写，有中文翻译为“具象状态传输”。REST 这个术语是由 Roy Fielding 在他的博士论文 《 Architectural Styles and the Design of Network-based ...
#### 一、REST简介与核心概念 REST（Representational State Transfer）是一种软件架构风格，最初由Roy Thomas Fielding在他的博士论文《Architectural Styles and the Design of Network-based Software ...
#### REST简介 REST（Representational State Transfer）代表了一种分布式超媒体软件架构风格，最初由Roy Thomas Fielding在他的2000年博士论文中提出。REST并不是一种具体的标准或者架构，而是一套简单的设计原则...
DZone 社区发布的《DZone_REST_Refcard_2011》是一份关于 REST（Representational State Transfer）架构风格的简介性文档。该文档通过一系列图表和文字描述，为读者提供了 REST 架构的基础知识及其在实际应用中的...
#### 一、REST简介与核心概念 **REST（Representational State Transfer，表述性状态转移）**是一种设计网络应用程序的架构风格，最初由Roy Fielding在其2000年的博士论文中提出。REST的核心理念是通过HTTP协议来...
##### REST简介 REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，用于不同平台客户端和服务端轻量级的通信。RESTful API的特点是无状态、可缓存、分层系统等，使得...
一说到REST，我想大家的第一反应就是“啊，就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束，以及如何开始搭建REST服务时，却很少有人能够清晰地说出它到底是什么，需要遵守什么样的准则。 博文...
REST 架构简介 - **背景**: REST（Representational State Transfer）是 Web 服务领域的一个重要概念，尤其在过去十年中，随着 Web 2.0 的发展而变得日益重要。REST 提供了一种简单且灵活的方式来构建 Web 服务，...
**jbpm-rest 简介** `jbpm-rest` 是一个基于 jBPM（Java Business Process Management）的简单 REST（Representational State Transfer）接口实现。jBPM 是一个开源的工作流和业务流程管理框架，它提供了强大的 ...