http接口开发与调用案例[通俗易懂]

http接口开发与调用案例[通俗易懂]http接口开发与调用案例

大家好,又见面了,我是你们的朋友全栈君。

本打算上周末要在家里写这篇博客的,无奈没有控制住自己的拖延症,一直拖到周一,但下定决心,这篇文章一定要发表出来的。
在以前做的的ITOO项目中,模块之间的调用使用的EJB的session bean,貌似是EJB对分布式事务支持的比较好,但也深受其害。比如A模块想要调用B模块,需要依赖B模块的实体。在A模块中,通过JNDI到B模块的服务器查找依赖的service bean,所以A模块想要调用B模块,即需要依赖B模块的实体bean,还需要依赖B模块的service bean。这种方案造成的问题是,一旦B模块的某个bean出现问题,整个调用关系便中断。而且EJB的session bean对高可用负载均衡部署方案支持不是很好,调用关系不稳定。
对比EJB的session bean,现在我们采用spring boot微服务架构开发接口。接口开发前,由接口开发方和接口调用方定义接口规范,接口规范确定后同步到wiki。接口开发方和接口调用方根据接口规范双向开展工作。对于接口开发方,我们的接口开发方式如下:

@Path("/***")
@Produces(MediaType.APPLICATION_JSON)
public class ***Resource { 
   

    @GET
    public ApiResponse list(@QueryParam("***") String ***, @DefaultValue("1") @QueryParam("***") int ***) {

        List<***DTO> *** = new ArrayList<>();

        ......

        return ApiResponseBuilder.ok().entity(***).build();
    }

}

list方法返回数据格式为ApiResponse实体,通过@Produces(MediaType.APPLICATION_JSON)注解,将实体转为json返回,ApiResponse实体内容如下:

public class ApiResponse { 
   

    public static final Object EMPTY = "";

    private int status;

    private String message;

    private Object entity = EMPTY;

    /** * */
    public static class ApiResponseBuilder{ 
   

        private ApiResponse apiResponse;

        public ApiResponseBuilder(ApiResponse resp){
            this.apiResponse = resp;
        }

        public static ApiResponseBuilder ok(){

            return status(HttpServletResponse.SC_OK).msg("ok");
        }

        public static ApiResponseBuilder status(int status){
            ApiResponse resp = new ApiResponse();
            resp.setStatus(status);

            return new ApiResponseBuilder(resp);
        }

        public ApiResponseBuilder msg(String msg){
            this.apiResponse.setMessage(msg);
            return this;
        }

        public ApiResponseBuilder entity(Object entity){
            this.apiResponse.setEntity(entity);
            return this;
        }

        public ApiResponse build(){

            return apiResponse;
        }
    }

    public int getStatus() {
        return status;
    }

    public void setStatus(int status) {
        this.status = status;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Object getEntity() {
        return entity;
    }

    public void setEntity(Object entity) {
        this.entity = entity;
    }
}

到此接口开发工作完成,然后我们运行spring boot的main方法,整个服务便跑起来了。对于接口如何支持高可用部署,可以参考高可用api接口网络部署方案
对于接口调用方,我们需要在application.properties配置下接口调用的url地址,代码级别,我们通过org.springframework.web.client.RestTemplate发起接口调用,我们的调用方式如下:

@Value(value = "${url}")
private String url;

RestTemplate temp = new RestTemplate();

String json = temp.getForObject(url, String.class, "***");

JsonNode root = ***.getJsonNode(json);

Entity entity = ***.getEntityFromJsonNode(root);

采用如上方式的接口开发与调用,开发方和调用方都依赖接口规范,这样可以很大程度的减小接口开发方和调用方的耦合关系,同时使用spring boot微服务架构,可以方便的部署接口高可用集群。
希望我的分享可以帮助到您进步。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/146211.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • 关于VMware无法输入许可证密钥的方法

    关于VMware无法输入许可证密钥的方法首先,把电脑里的VMware卸载掉设置—-应用—-找到VMware——修改—-删除VMware不要保留任何配置文件其次,找到你的VMware安装文件,要知道它在哪或者把它放在一个比较好找的地方打开任务管理器—左上角文件—-运行新任务—然后按图片走等待安装完毕后就能正常输入许可证密钥了…

    2025年11月15日
    2
  • python anaconda和pycharm的区别_质量度三者关系

    python anaconda和pycharm的区别_质量度三者关系哈喽~大家好呀Python作为深度学习和人工智能学习的热门语言,你们知道Python、Pycharm、Anaconda三者之间的关系吗?学习一门语言,除了学会其简单的语法之外还需要对其进行运行和实现,才能实现和发挥其功能和作用。下面来介绍运行Python代码常用到的工具总结。一.Python、Pycharm、Anaconda关系介绍1.PythonPython是一种跨平台的计算机程序语言。是一个高层次的结合了解释性、编译性、互动性和面向对象的脚本语言。最初被设计用于编写自动…

    2022年8月29日
    5
  • 我的世界区块显示_我的世界怎么显示区块线

    我的世界区块显示_我的世界怎么显示区块线我的世界手游区块是一个独特的机制,很多玩家对于区块是什么不太了解,区块显示指令以及区块的产生不是很熟悉,为了帮助到大家,今天小编就为大家带来我的世界手游区块显示指令分享:区块玩法操作详解的内容,希望大家能够喜欢,下面就让我们一起来看看吧!区块相关1.出生点区块在出生点附近的区块是一块围绕世界出生点的区域中的一个区块,只要有玩家在主世界,它就不会被从内存中卸载。这意味着像红石元件和刷怪会继续,甚至所…

    2025年12月11日
    2
  • mybatis log plugin激活码激活流程[最新免费获取][通俗易懂]

    (mybatis log plugin激活码激活流程)好多小伙伴总是说激活码老是失效,太麻烦,关注/收藏全栈君太难教程,2021永久激活的方法等着你。IntelliJ2021最新激活注册码,破解教程可免费永久激活,亲测有效,下面是详细链接哦~https://javaforall.net/100143.html1STL5S9V8F-eyJsaWNlbnNlSWQi…

    2022年3月27日
    36
  • 测试用例附实例[通俗易懂]

    一、测试用例的概念测试用例是测试过程中很重要的一类文档,它是测试工作的核心,是一组在测试时输入和输出的标准,是软件需求的具体对照。二、测试用例的作用检验软件是否满足客户需求 测试人员的工作量的一种体现 展示测试用例的设计思路三、测试用例的内容测试用例八个基本项是:测试用例编号、测试项目、测试标题、重要级别、预置条件、输入、操作步骤、预期输出(不同公司的测试用例内容不尽相同…

    2022年4月13日
    55
  • 傅里叶、拉普拉斯、z变换常用公式合集「建议收藏」

    傅里叶、拉普拉斯、z变换常用公式合集「建议收藏」傅里叶变换常用信号的傅里叶变换傅里叶变换的性质傅里叶性质—典型变换对拉普拉斯常用信号的单边拉普拉斯变换拉普拉斯变换的性质z变换常用序列的z变换z变换的性质…

    2022年7月17日
    22

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号