服务接口开发（服务 接口）

本篇文章给大家谈谈服务接口开发，以及服务 接口对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享服务接口开发的知识，其中也会对服务 接口进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、服务端接口开发注意事项
• 2、嵌入式web服务器支持服务接口开发么
• 3、SpringBoot|| Spring Cloud 整合cxf开发webService接口服务端-流程步骤
• 4、magic-api 快速接口开发
• 5、如何开发webservice接口

服务端接口开发注意事项

1、接口接入日志

2、接口安全校验，预防纵向越权和横向安全。纵向越权是多用户角色的系统，低权限角色的用户不能访问高权限角色用户的数据。横向越权，具有相同角色权限的A和B，A不能通过接口操控B的数据。

3、考虑业务场景下的事务。既同一个接口内修改不同的数据表，要保证数据的原子性。

4、对接口做并发安全测试，保证数据修改安全。

5、接口的限流

6、接口的降级

8、接口的全链路日志，提供链路唯一标识。

9、接口关键业务的日志

10、接口要具备职务单一原则，一个接口不要通过不同条件判断实现多种业务。

11、接口定义，根据业务需求慎重考虑接口请求字段和响应字段，定义是考虑可扩展性。

12、考虑是否使用分布式锁。接口多实例部署时，对唯一资源需要考虑并发安全。

12、接口文档描述清晰明确

13、接口不同版本的兼容

14、接口的测试。全业务场景覆盖的单元测试。

15、接口的发布

16、重发与幂等性

嵌入式web服务器支持服务接口开发么

仅支持部分。
为了提高对设备的易操作性，很多设备中提供pc机直接通过浏览器操作设备的功能。这就需要在设备中实现web服务器。现在在嵌入式设备中所使用的web服务器主要有：boa、thttpd、mini_httpd、shttpd、lighttpd、goaheand、appweb和apache等。
现在的嵌入式linux中CGI程序主要使用C语言。对于编写C语言的CGI程序，可以编写好程序之后，在linux操作系统下编译，用针对硬件平台的linux的交叉编译工具编译就可以，写的html网页界面在记事本写即可。我以前写的CGI程序就是在此环境下写的。这也是最普遍的开发方法。

SpringBoot|| Spring Cloud 整合cxf开发webService接口服务端-流程步骤

Apache CXF 是一个开源的 Service 框架，简化用户的 service 开发，基于CXF开发的应用可提供 SOAP 、 XML/HTTP 、 RESTFUL HTTP 或 CORBA 等服务。 CXF 底层页可以使用不同的传输协议，包括 HTTP 、 JMS 或 JBI 等。

自定义注解标注要发布的服务类，发布出去

在接口上添加 @WebService 注解

通过浏览器访问wsdl，wsdl路径即为发布的路径加上?wsdl

:[端口号]/cxf/test?wsdl

可以看到接口就成功服务接口开发了。

到此服务端开发结束！

如果是soapui工具，发送的参数包括xml的服务接口开发：将xml写在 <![CDATA[ 【xml】]] 里面

magic-api 快速接口开发

magic-api 是一个基于Java的接口快速开发框架，编写接口将通过magic-api提供的UI界面完成，自动映射为HTTP接口。

1，引入magic-api-spring-boot-starter依赖
org.ssssssss

magic-api-spring-boot-starter

1.7.1
2，application.yml 中配置

magic-api:

#配置web页面入口

web: /magic/web

resource:

# location: /data/magic-api

type: database # 配置接口存储方式，这里选择存在数据库中

table-name: magic_api_file # 数据库中的表名

3，启动服务，访问magic-api web页面

magic-test/magic/web

1，RequestParam

GET http://localhost:9999/xxx/xxx?name=abcage=49

这样的URL参数magic-api 会自动将name和age映射为同名变量

2，表单参数

POST http://localhost:9999/xxx/xxx

name=abcage=49

这样的表单参数magic-api 也会自动将name和age映射为同名变量。

3，Request Header参数获取

magic-api 会对所有RequestHeader统一封装为一个名为header的变量 如要获取 token 可以通过header.token 来获取。

4，POST请求的Request Body参数获取

{

"name": "magic-api"

}

如要获取name属性 则可通过 body.name 来获取

5，Path参数获取

主要是针对URL定义为http://localhost:9999/user/{id} 的类似接口

如要获取path路径上的id可通过path.id 或 id来获取

6，Cookie，Session参数获取

可以通过cookie.xxx，session.xxx来获取

1，#{} 注入参数，${} 拼接参数

作用和mybatis用法一致

id = #{id};

id=${id};

2，动态SQL参数

通过?{condition,expression}来实现动态拼接SQL，如果条件成立则拼接后部分内容SQL中，与mybatis中的if标签基本一致

return db.select("select * from sys_user ?{id,where id = #{id}}");

相当于mybatis中的

3，Mybatis 语法支持

1.6.0以后的版本支持Mybatis语法

操作入口 db.table('table_name')

1，insert

return db.table('sys_user').insert({ user_name : '李富贵', role : 'admin'})

// insert into sys_user(user_name,role) values('李富贵','admin')

2，update

return db.table('base_dict').primary('code').update({ code: 'insertTerst', name : '测试insert'})

//update base_dict set name = ? where code = ?

3，save

用法和insert相似

return db.table('sys_user').primary('id', uuid()).save({user_name: '李富贵'});

// insert into sys_user(id,user_name) values('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx','李富贵');

4，select，page，where

return db.table('sys_user').select()

return db.table('sys_user').page()

return db.table('sys_user')

.where()

.like('user_name','%李富贵%')

.eq('role','admin')

.select()

yml中配置分页参数

magic-api:

page-config:

size: size # 页大小的请求参数名称

page: page # 页码的请求参数名称

default-page: 1 # 未传页码时的默认首页

default-size: 10 # 未传页大小时的默认页大小

自动分页

使用yml中配置的分页参数

return db.page("""select * from base_dict_detail""")

手动分页

跳过前3条记录，然后取5条

return db.page("""select * from base_dict_detail""",5,3)

自定义分页参数获取

实现 PageProvider接口，复写getPage方法 {

public Page getPage(RuntimeContext runtimeContext) {

long page = 2;

long pageSize = 3;

return new Page(pageSize, (page - 1) * pageSize);

}

此模式会覆盖yml的配置内容

目前内置了三种状态码，分别为 执行成功(1)，参数验证失败(0)，以及系统异常(-1)

自定义状态码

magic-api:

response-code-config:

success: 200 #执行成功的code值

invalid: 400 #参数验证未通过的code值

exception: 500 #执行出现异常的code值

默认返回格式

{

"code": 1, // 状态码

"message": "success", // 状态说明

"data": ..., // 返回的数据内容

"timestamp": 1629610503506, // 服务器时间

"executeTime": 1 // 执行时间

}

自定义返回格式

magic-api:

response: |- #配置JSON格式，格式为magic-script中的表达式

{

code: code,

message: message,

data,

timestamp,

requestTime,

executeTime,

}

自定义结构配置

实现ResultProvider接口，重写buildResult方法

引入swagger依赖

在yml文件中配置

magic-api:

swagger-config:

version: 1.0.0

description: magic测试文档

title: magic测试

name: 配置化实现

location: /v2/api-docs/magic-api/swagger2.json

Magic-api通过springboot自动配置的方式配置了resource,dataSource,interceptor等内容。

在服务启动时，生成MagicConfiguration注入容器时，通过mappingHandlerMapping.registerAllMapping();来注册所有映射(即在界面上配置的接口请求地址和接口的实际处理类、方法的映射)。映射关系注册到handleMapping中，并在内存中通过ConcurrentHashMap来缓存映射关系

接口调用时，在DispatcherServlet中通过url去寻找handler,找到magic-api的统一处理RequestHandler以及处理方法invoke。

在invoke中根据请求方法和路径获取接口信息封装在ApiInfo中，然后进行参数的验证封装。实际脚本的执行，以及对返回结果的包装

如何开发webservice接口

以下是操作步骤：
1、编写服务代码
服务代码提供了两个函数，分别为sayHello和sayHelloToPerson，在HelloService.java类中
2、发布WebService
要将上边写的HelloService类发布为WebService，需要先搭建Web应用。下面是在Tomcat下使用Axis创建WebService服务的例子。
3、在Tomcat下创建Web应用
在该例子中，在Tomcat下创建了一个context path为test_webservice的WEB应用。
（1） 在Tomcat的webapps下创建如下文件系统
test_webservice
WEB-INF
lib
Classes
（2）在WEB-INF文件夹下创建web.xml文件，在web.xml中主要是配置axis。
4、复制axis相关的jar文件
将axis的相关jar文件复制到WEB-INF\lib文件夹下。这些文件包括：
activation.jar
axis.jar
axis-ant.jar
axis-schema.jar
commons-discovery-0.2.jar
commons-logging-1.0.4.jar
jaxrpc.jar
log4j-1.2.8.jar
mailapi.jar
saaj.jar
wsdl4j-1.5.1.jar
xmlsec-1.3.0.jar
5、测试发布的WEB应用
启动Tomcat服务，打开IE浏览器，访问http:host:port/test_webservice/services，
如果看到如下界面就说明AXIS部署成功了。
6、发布WebService
发布WebService需要使用现有的AdminService来实现，这里我写了一个批处理文件来发布WebService，以后如果需要发布其他文件，只需要修改相应的参数就可以了。
（1）创建deploy.wsdd文件。
（2）创建发布WebService服务的批处理文件deploywebservice.bat。
其中E:\workspace\Libwebservice是存放axis对应的jar文件的文件夹，现在将所有的jar文件都加入到此文件夹中。
-l后的参数是本地要发布WebService的AdminService对应的访问地址。
最后deploy.wsdd是对应的配置文件名称。
（3） 将deploy.wsdd文件和deploywebservice.bat文件复制到同一个文件夹下，执行deploywebservice.bat批处理文件，就可以将deploy.wsdd中描述的Java类发布为WebService。发布完成之后再访问http://host:port/test_webservice/services 关于服务接口开发和服务 接口的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 服务接口开发的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于服务 接口、服务接口开发的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。