REST简介

最新推荐文章于 2021-04-01 15:40:19 发布
最新推荐文章于 2021-04-01 15:40:19 发布
阅读量158 收藏
点赞数
分类专栏： 开源框架 文章标签： java json 网络
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/peixun123/article/details/84814870
版权

 

 

名词解释

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的标准，客户端和服务端可以双向通讯，但实现较为复杂

 

 

 

 

 

参考

Jersey注解

Resteasy常用注解

Java Restful Web Services （二）——参数注解1

webservice框架jersey简单总结

 

 

 

 

 

peixun123
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
REST术语解释
轻松 Service
10-16 213
0. REpresentational State Transfer   1. REST的提出在2000年的一篇博士论文里第五章   2. REST的创始者是Roy Fielding博士 (罗伊.菲尔丁)。他同也是HTTP和URL的创作者，也是Apache HTTP服务器的主要贡献者之一   3. 资源（resource）、表示（representation）、连接器（connector）、组件（...
rest plugin 学习（一）
myw
03-24 186
[size=small]1.官方介绍的地址： [url]http://struts.apache.org/2.1.6/docs/rest-plugin.html[/url] 2.struts.xml文件配置 必须和convention插件配合使用。但是如果直接使用肯定会报错，会报index方法找不到，由其是我们在使用config-browser插件时。原因是restful插件默认...
rest 请求类型
wendy_dw的博客
03-07 637
例如：对资源http://www.bupt.edu.cn/stu201311 1） 发出POST请求，表示增加学生stu201311 2）； 发出PUT请求，表示修改学生stu201311的信息，例如修改学生的姓名 3）； 发出DEL请求，表示删除学生stu201311的信息 4）； 发出GET请求，表示查看学生stu201311的信息； ...
REST服务4种类型
zsl8515的博客
02-05 936
https://segmentfault.com/a/1190000002489170
分布式事务基础理论——CAP理论
保暖透气大裤衩LeoLee的博客
11-09 402
CAP理论 全称：Consistency & Availability & Partition tolerance，分别是一致性、可用性、分区容忍性，这是分布式架构当中最基础的理论。 以电商场景为案例帮助我们理解概念： 这是一个典型的读写分离场景 Consistency 一致性是指写操作后的读操作可以读取到最新的数据，当数据分布在多个节点，从任意节点读取的到的数据都是最新的。 以上图为例，商品信息如果需要做一致性保证的话，就要做满足如下要求： 商品服务写入主数据库成功，向
Rest简介及Spring实现
04-04
**Rest简介** REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，主要用于Web服务的构建。RESTful架构强调无状态、客户端-服务器架构、统一接口等原则，使得系统更加...
Django REST framework 简介.md
08-26
drf框架的使用和简介，Django REST framework可以帮助我们简化上述两部分的代码编写，大大提高REST API的开发速度。
P1_准备工作_P2_REST简介_P3_API对外合约_Routine.Api2020_2_5.rar
02-10
使用 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实战
07-22
资源名称：REST实战内容简介：为何典型的企业项目无法像你为web所开发的项目那样运行得如此平滑？对于建造分布式和企业级的应用来说，rest架构风格真的提供了一个可行的替代选择吗？在这本富有洞察力的书中，三位soa...
DHC Rest Client
06-25
1. **DHC Rest Client简介** DHC Rest Client是一个强大的桌面应用程序，它允许用户通过直观的界面发送HTTP请求，并接收相应的HTTP响应。这款工具支持多种HTTP方法，包括GET、POST、PUT、DELETE等，同时还支持JSON...
HTTP的REST服务简介和最佳实践
05-16
一说到REST，我想大家的第一反应就是“啊，就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束，以及如何开始搭建REST服务时，却很少有人能够清晰地说出它到底是什么，需要遵守什么样的准则。 博文...
rest api 接口测试工具
03-01
二、Advanced REST Client (ARC) 简介 Advanced REST Client是Google Chrome浏览器的一个扩展，它是一个强大的REST API测试工具。版本v3.1.9提供了以下功能： 1. 支持所有HTTP方法：包括基本的GET、POST、PUT、...
REST Server in Delphi XE Using DataSnap中文版
10-25
REST 架构简介 - **背景**: REST（Representational State Transfer）是 Web 服务领域的一个重要概念，尤其在过去十年中，随着 Web 2.0 的发展而变得日益重要。REST 提供了一种简单且灵活的方式来构建 Web 服务，...
REST API_01.docx
09-15
#### 二、REST API简介 REST（Representational State Transfer）是一种用于构建HTTP API的设计风格，由罗伊·菲尔丁（Roy Fielding）提出。REST提供了一种标准化的方式来创建和管理API接口，尤其强调了HTTP方法的...
REST接口设计规范
zghwaicsdn的专栏
12-21 2万+
REST接口设计规范 10 NOVEMBER 2015 URI格式规范 URI(Uniform Resource Identifiers) 统一资源标示符URL(Uniform Resource Locator) 统一资源定位符 URI的格式定义如下： URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragm
es6学习：函数参数默认值、rest参数、扩展运算符和symbol数据类型
sunshine_0880的博客
04-01 322
1. 函数参数默认值（es6允许给函数参数赋值初始值） 1.1 形参初始值 具有默认的参数，一般位置置后(潜规则) let add = (a, b, c = 10) => (a + b + c) let result1 = add(1, 2, 3) let result2 = add(1, 2) console.log(result1, result2) // 6 13 待更新... ... ...
REST接口规范---关键点
yyjava的专栏
08-13 7048
关于REST 前后端接口按照粗浅的REST规则制定，其主要表现为： 使用GET、POST、PUT、DELETE共4个HTTP Method，而非简单的GET和POST两者。 响应使用HTTP状态码来标志请求的执行结果，而非以往的success字段。 URL符合业界普遍接受的REST规则，减少在URL中标识操作类型的情况，如使用POST /users代替POST /users/save。 出...
REST，以及RESTful的讲解
热门推荐
九师兄
04-21 20万+
1.传统下的API接口 　　http是目前在互联网上使用最多的协议，没有之一。 　　可是http的创始人一直都觉得，在过去10几年来，所有的人都在错误的使用Http.这句话怎么说呢？ 　　如果说你要删除一个数据，以往的做法通常是 delete/{id}　 　　如果你要更新一个数据，可能是Post数据放Body，然后方法是 update/{id}， 或者是artichle/{id}?meth...
REST架构探索：实战、争议与未来
1. **REST 简介**：作者 Stefan Tilkov 在文章中引导读者理解当前关于异构应用间通信的两种主要观点：主流是基于 SOAP、WSDL 和 WS-* 规范的 Web 服务，而一小部分人则主张 REST 是更好的选择，这引发了关于两种方法...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值