微服务开发手册范本Word格式文档下载.docx
- 文档编号:14532107
- 上传时间:2022-10-23
- 格式:DOCX
- 页数:16
- 大小:29.28KB
微服务开发手册范本Word格式文档下载.docx
《微服务开发手册范本Word格式文档下载.docx》由会员分享,可在线阅读,更多相关《微服务开发手册范本Word格式文档下载.docx(16页珍藏版)》请在冰豆网上搜索。
2.restapi接口规
springboot接口设计需符合restful风格。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
而客户端要执行某种类型的操作,需要根据http的操作协议来决定。
HTTP提供了常用的几种操作,如下表:
动作
说明
GET(SELECT)
从服务器取出资源(一项或多项)
POST(CREATE)
在服务器新建一个资源。
PUT(UPDATE)
在服务器更新资源(客户端提供改变后的完整资源)。
PATCH(UPDATE)
在服务器更新资源(客户端提供改变的属性)。
DELETE(DELETE)
从服务器删除资源。
对数据库的增删改查操作,应该严格遵守上面定义的五种HTTP动作。
对于更新动作,参数通过requestbody来传递,格式为json。
服务端返回数据格式也均为json。
服务端返回数据对象约定:
publicclassUnifyInfo{
privateintcode;
//返回代码,1:
成功,0:
失败
privateStringmessage;
//返回信息提示
privateStringprompt;
//
privateStringpath;
//一般用于错误时的跳转路径
privateHashMap<
String,?
>
attribute;
//一般用于查询时的返回数据容
}
Springboot会自动将符合javabean格式的对象转换为json格式数据返回。
示例:
客户端请求
请求参数
服务端返回数据
GET/users
{"
code"
:
"
1"
"
message"
查询成功"
prompt"
path"
users"
[]}
查询所有用户
GET/users/ID
查询指定ID的用户
POST/users
username"
user2"
email"
666633433qq."
0"
创建用户失败"
该用户已经存在"
localhost:
8080/users"
result"
{}}
创建一个用户
PUT/users/ID
创建用户成功"
更新某用户信息
PATCH/users/ID
更新成功"
更新某用户指定字段
DELETE/users/ID
删除成功"
删除指定用户
而对于登录、登出操作,可以理解为登录是创建token,登出是删除token,所以可以用POST和DELETE来定义这两种接口。
刷新token是更新操作所以用PUT。
3.配置文件管理
所有服务的配置文档均保存于gitlab上,并通过配置服务config-service来获取配置。
每个服务在gitlab均保存一份以服务id命名的properties文件。
以服务spring-boot-demo为例,其在gitlab上的配置文件为spring-boot-demo.properties,文件名对应于该服务的bootstrap.properties中配置的spring.application.name的value值。
如果名称不一致,配置服务将拿不到正确的配置信息。
在spring-boot-demo.properties常配置该服务的启动端口、数据库连接参数等信息。
当该文件有更新并push到gitlab后,配置服务会自动通知客户端服务更新配置信息。
关键配置:
在主程序中需要访问配置文件的类名上加上注解:
RefreshScope,如果没有该注解,配置服务将不能主动通知客户端服务更新配置。
如下:
RefreshScope
RestController
publicclassMessageRestController{
Value("
${message:
Hellodefault}"
)
RequestMapping("
/message"
StringgetMessage(){
returnthis.message;
}
当spring-boot-demo.properties文件里的message变量发生变化后,请求/message时返回的message值将是更新后的message容。
pom.xml关键依赖项:
<
dependency>
groupId>
org.springframework.cloud<
/groupId>
<
artifactId>
spring-cloud-config-client<
/artifactId>
/dependency>
<
org.springframework.boot<
spring-boot-starter-actuator<
同时需要引入springcloud的依赖项
dependencyManagement>
dependencies>
spring-cloud-dependencies<
version>
Camden.SR5<
/version>
type>
pom<
/type>
scope>
import<
/scope>
/dependencies>
/dependencyManagement>
在src/main/resouce目录建立bootstrap.properties文件,设置配置服务url与serviceid。
bootstrap.properties文件容:
#配置服务地址
spring.cloud.config.uri=172.168.4.43:
9999
#servicename
spring.application.name=spring-boot-demo
注:
不能在application.properties设置配置服务的url,因为application.properties的启动优先级最低,不能在程序启动之前读取到配置服务url,从而不能加载配置服务上相应的配置。
4.服务注册
register-service提供服务的注册与发现。
所有的服务都需要注册到register-service中,否则不能够被其他服务发现与调用,比如路由服务。
关键配置
spring-cloud-starter-eureka-server<
主程序加上注解:
EnableEurekaServer如下:
EnableEurekaServer
SpringBootApplication
publicclassRegisterServiceApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(RegisterServiceApplication.class,args);
对应配置服务器上的spring-boot-demo.properties中添加注册服务的地址。
spring-boot-demo.properties配置如下:
#服务启动端口
server.port=8082
#注册服务地址
eureka.client.serviceUrl.defaultZone=172.168.4.43:
9998/eureka/
5.统一网关路由
所有rest请求均需要通过网关来路由到具体的服务。
网关服务能起到负载均衡、动态路由、统一认证等功能。
使用代理服务能够避免必须的跨域资源共享(Cross-OriginResourceSharing)。
当一个UI应用调用一个或更多的后端服务的时候,通过网关服务来做统一的代理。
前端应用不再需要关心后台业务服务的具体地址,因此当业务服务的地址变更后也不需要修改应用端的配置。
所有的请求都在网关做了统一的认证授权,因此业务服务也不再需要考虑与授权有关的问题。
按照约定,一个serviceid为"
userservice"
的服务会收到
/userservice请求路径的代理请求(前缀会被剥离)。
因此要查询用户ID是590d38b064328b1aa
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 微服 开发 手册 范本