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)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • 超全Python图像处理讲解(多图预警)

    超全Python图像处理讲解(多图预警)文章目录Pillow模块讲解一、Image模块1.1、打开图片和显示图片1.2、创建一个简单的图像1.3、图像混合(1)透明度混合(2)遮罩混合1.4、图像缩放(1)按像素缩放(2)按尺寸缩放1.5、图像的剪切与粘贴(1)图像粘贴(2)裁剪图像1.4、图像旋转和格式转换(1)图像旋转(2)格式转换1.5、分离和合并(1)分离(2)合并二、ImageFilter2.1、高斯模糊2.2、其它滤镜三、…

    2022年6月20日
    44
  • ideavim怎么用_intellij idea使用教程2020

    ideavim怎么用_intellij idea使用教程2020IdeaVim-常用操作IdeaVim简介IdeaVim是IntelliJIDEA的一款插件,他提高了我们写代码的速度,对代码的跳转,查找也很友好。安装之后它在Tools>VimEmulator具体操作i模式i模式即为编辑模式,按下字母i开启就可以打字。Esc从i模式切换为Vim,按下键盘的Esc键切

    2022年9月30日
    3
  • oracle 11g安装教程完整版

    oracle 11g安装教程完整版64位WIN7+oracle11g+plsql安装上部转自Oracle11gR2forWin7旗舰版(64位)的安装步骤1、下载Oracle11gR2forWindows的版本 下载地址:http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html 其中包括两个压

    2022年7月26日
    6
  • java 异步调用接口_Java接口异步调用[通俗易懂]

    java 异步调用接口_Java接口异步调用[通俗易懂]java接口调用从调用方式上可以分为3类:同步调用,异步调用,回调;同步调用基本不用说了,它是一种阻塞式的调用,就是A方法中直接调用方法B,从上往下依次执行。今天来说说异步调用。什么是异步调用?我的理解就是在方法A中调用方法B,但是方法B很耗时,如果是同步调用的话会等方法B执行完成后才往下执行,如果异步的话就是我调用了方法B,它给我个返回值证明它已接受调用,但是它并没有完成任务,而我就继续往下执行…

    2022年7月11日
    213
  • 如何远程连接树莓派_树莓派远程连接密码错误

    如何远程连接树莓派_树莓派远程连接密码错误PyCharm远程连接树莓派我听说有些人很刚,直接用树莓派连接显示器写代码,在下实在佩服。树莓派4B已经出来,估计这个方式能接受。只有树莓派3B的我,只能想办法远程连接一下了。1、树莓派接入网络其实就是插上网线,让树莓派和你的电脑在同一局域网内。说白了,就是插在同一个路由器上。2、配置PyCharm树莓派接入网络以后,其实你可以用XShell来写代码,但是我等新手,想用PyCharm怎…

    2022年8月28日
    6
  • postman 导出python爬虫代码

    postman 导出python爬虫代码postman导出python爬虫代码importrequestsurl=”https://www.baidu.com/”payload={}headers={‘Connection’:’keep-alive’,’Cache-Control’:’max-age=0′,’sec-ch-ua’:'”GoogleChrome”;v=”95″,”Chromium”;v=”95″,”;NotABrand”;v=”99″‘,’sec-ch-ua-mobil

    2022年5月27日
    38

发表回复

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

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