借助Gradle Plugin解决模块化开发中模块如何对外暴露接口

直奔主题,在模块化开发中,模块间的数据交流大多数同学会采用以接口作为通信协议的方式。需要面对的问题有以下几点:

接口由谁来维护?
这个问题简单,由提供服务的模块来维护。
接口怎么暴露?
打成jar包,发布到maven。
接口在哪里维护?
现在可以参考的方案有三种:一. 所有相关模块的接口统一在一个模块中维护;二. 各个模块的接口分别在自建一个新的模块中维护,通过命名规则一一对应;三. 像微信的.api方案,使用特殊的规则混杂在各自的模块中。

如果接着第一个问题,方案一好像就有点难确定接口对应的来源模块。方案二会出现接口模块成倍增加,极易出现一个模块只含一个接口类的现象。方案三需要自定义相关插件,在创建接口时会有点不便,不够灵活。

MIS登场!!!接下来先介绍mis的简单使用以及背后的原理。
MIS
模块接口服务(Module Interface Service)
MIS是从微信的.api方案演变而来,主要解决的问题是如何在一个模块内维护其对外暴露的接口(包括打包发布),而不是把接口和接口实现分离到两个不同的模块。


Usage
引用 mis 插件
在根项目的build.gradle中添加mis插件的classpath:

在根项目的build.gradle中添加mis插件的classpath:

在模块的build.gradle中添加mis插件:

...
apply plugin: ‘mis‘

创建 mis 目录
Gradle Sync后,在java同级目录创建mis文件夹

定义接口,并实现接口服务
直接在mis文件夹下,创建对应的包名、接口类和数据Model。并在java文件夹下实现接口服务。

配置mis相对应的publication

mis {
    publications {
        main {
            groupId ‘com.eastwood.demo‘
            artifactId ‘library-sdk‘
            // version ‘1.0.0-SNAPSHOT‘

            dependencies {
                compileOnly ‘com.google.code.gson:gson:2.8.1‘
            }
        }
    }
    ...
}

main指的是src/main/java中的main,除了main之外,其值还可以为 build types和product flavors对应的值,即对应目录下的mis。比如与src/debug/java对应的src/debug/mis。
groupId、artifactId、version对应的是Maven的GAV。初次配置时不设置version,发布至maven时设置version。
在dependencies中可声明该mis编译和运行时需用到的第三方库,仅支持compileOnly和implementation。

发布至Maven

mis {
    publications {
        main {
            groupId ‘com.eastwood.demo‘
            artifactId ‘library-sdk‘
            version ‘1.0.0-SNAPSHOT‘
            ...
        }
    }

    repositories {
        maven {
            url "http://***"
            credentials {
                username ‘***‘
                password ‘***‘
            }
        }
    }
    ...
}

发布时需设置version。

发布时内部用到的插件是maven-publish
Gradle Sync后,打开Gradle Tasks View,选择publishMis[...]PublicationToMavenRepository执行发布任务。


其中publishMis[...]PublicationToMavenLocal 是发布至本地maven。如果使用本地maven,请将mavenLocal()添加至根项目的build.gradle中,比如:

allprojects {
    repositories {
        google()
        jcenter()
        mavenLocal()
    }
}

Q&A
1.mis目录下的类会参与编译吗?
不会。虽然mis目录下的类能被java目录下的类直接引用,但不会参与编译,真正参与编译的是该mis目录生成的jar包,其位于当前工程.gradle/mis下。在当前工程Sync&Build的时候,mis插件会对这些配置了publication的mis目录进行编译打包生成jar包,并且依赖该jar包。
mis目录下的类之所以能被java目录下的类直接引用,是因为mis目录被设置为sourceSets aidl的src目录,而Android Studio对sourceSets aidl的src目录有特别支持。
2.没有Maven私服,所有模块都在一个工程下,其他模块怎么引用接口?
不设置publication的version。通过misPublication声明依赖,比如:

dependencies {
    ...
    implementation misPublication(‘com.eastwood.demo:library-sdk‘)
}

misPublication运行机理是会自动在当前工程.gradle/mis下查找是否有对应的mis提供的jar包。如果有,就使用对应的mis提供的jar包;如果没有且指定了version,就使用maven上的jar包。
3.将接口发布到maven后,其他模块通过misPublication声明依赖,那jar包用的是.gradle/mis下的还是maven上的?
接口被发布到maven后,其.gradle/mis下的jar包会被删除,接口所在的模块根据publication中设置的GAV使用maven上的jar包。如果其他模块通过misPublication声明对其依赖,比如:

dependencies {
    ...
    implementation misPublication(‘com.eastwood.demo:library-sdk‘)
    // 或 implementation misPublication(‘com.eastwood.demo:library-sdk:1.0.0-SNAPSHOT‘)
}

不管misPublication中是否设置了的version,都会使用maven上的jar包,其版本同接口所在的模块publication中的GAV。
当mis目录下类发生实质性的修改后(生成不同的jar包),在当前工程Sync&Build的时,会在.gradle/mis下的重新生成jar包,接口所在的模块不管publication中是否设置version,都使用.gradle/mis下的jar包。如果其他模块通过misPublication声明对其依赖,不管misPublication中是否设置的version,都会使用.gradle/mis下的jar包。
4.为什么在Gradle Tasks View中找不到publishing相关发布Task?
初次发布时,请检查对应的publication是否已经设置的version,以及是否添加相关repositories。

原文地址:http://blog.51cto.com/13981400/2328841

时间: 2024-10-03 13:40:11

借助Gradle Plugin解决模块化开发中模块如何对外暴露接口的相关文章

解决QML开发中ComboBox中一个已选择项没有清除的问题

解决QML开发中ComboBox中一个已选择项没有清除的问题 近期使用QML开发一个项目.须要使用ComboBox进行显示.当进行一个操作时,须要向ComboBox加入一个元素,当进行另外一个操作时.须要清除ComboBox里面的元素. 可是在操作的过程中,出现了一个诡异的现象--ComboBox里面的已选择项并没有清除. 以下是程序的截图,能够看到.ComboBox中已选择项并没有删除.可是ComboBox中的候选项已经删除了. 我在QTCN上进行提问.后面再大家的努力下,最终把这个问题攻克了

android -------- 解决NDK开发中的 Method 'NewStringUTF' could not be resolved

创建NDK项目时, .cpp文件中出现错误, Method 'NewStringUTF' could not be resolved 如图: 网上看了很多解决方式 项目右键->属性->c/c++常规->Code Analysis,选择"Use project settings"  中的方法无法被解析(Method cannot be resolved)取消选择,应用->确定,然后刷新.清理.刷新.build项目.搞定. 我的是这样改了之后也没成功 , 我在cle

用 Nokitjs 解决前端开发中的跨域问题

问题 在开发一些「单页应用」时,通常会使用 Ajax 和服务器通讯,比如 RESTful API,通常「前端」和「服务端 API」可能是有不同人员在负责,也不在同一个工程下,那么开发过程中就可能会遇到跨域的问题,比如 Chrome 会在 console 中看到这样的错误消息: XMLHttpRequest cannot load http://google.com/. No 'Access-Control-Allow-Origin' header is present on the reques

[疑难杂症]解决实际开发中各种问题bug

我有一个习惯就是遇到问题找到解决方案后收藏网页.后来遇到问题越来越多,收藏就多得有点离谱了.我反思了一下,其实有用的信息就那么点,那我干脆还是做成网页剪报好了. 关于VS的 Problem:未能正确加载XX包 Solution:删除C:\Users\XX\AppData\Local\Microsoft\VisualStudio\12.0\ComponentModelCache里的Microsoft.VisualStudio.Default.cache.然后重启VS. PS:devenv /Res

分分钟解决iOS开发中App启动广告的功能

前不久有朋友需要一个启动广告的功能,我说网上有挺多的,他说,看的不是很理想.想让我写一个,于是乎,抽空写了一个,代码通俗易懂,简单的封装了一下,各种事件用block回调的,有俩种样式的广告,一种是全屏广告,另一种是下面露logo的,类似网页新闻的启动广告.依赖SDWebImage主要用来下载网络的广告图片,一般项目里面网络图片都用的这个框架,所以在此不做过多的阐述.下面让我们来看看我封装的过程,对于新手来说,可以学习一下这种封装的思想. 1.首先建一个继承View的LBLaunchImageAd

php解决微信开发中用户昵称中的特殊字符与emoji表情写入mysql错误的问题

解决办法:将3个字节的特殊字符与emoji表情替换掉即可. $nickname = preg_replace('/xE0[x80-x9F][x80-xBF]'.'|xED[xA0-xBF][x80-xBF]/S','?', $nickname ); $nickname = preg_replace('/\xEE[\x80-\xBF][\x80-\xBF]|\xEF[\x81-\x83][\x80-\xBF]/', '', $nickname);

解决android开发中eclipse不能自动提示

Eclipse中window->Preferences->Java->Editor->Content Assist->Advanced->顶部的选项卡Select the proposal kinds contained in the 'default' content assist list: 中把”Java Proposals“ 选项打上勾.

tomcat配置虚拟路径,可以解决实际开发中测试时前端访问后台电脑上的图片的问题

首先电脑上要已经安装好tomcat,安装tomcat的教程可以从网上找到很多.这里就不赘述了. 一般开始做一个web项目后,会涉及到用户头像,商品图片等信息,这些图片保存在项目中不方便,于是我将选择保存在某个磁盘的一个文件夹中,例如 D:/img 这样的话,使用全路径会相应的有些不方便,于是我就选择在tomcat中配置虚拟路径,打开tomcat目录 找到他的配置文件夹conf,然后打开,看见如下所示 然后用某个文本编辑器(记事本格式乱,不建议使用)打开 server.xml 文件,在最后找到 <

关于WP8.1开发中,调用网络API接口时JSON无法反序列化的解决方法

分享一个自动生成json的C#对象的方法网址: http://tools.wx6.org/json2csharp/ 复制后就在项目中新建一个类,类名可以按照自动生成的Root,也可以自定义,自定义的话,别忘了修改复制的类名 如自定义类名为C,则把Root改成C 关于复杂的嵌套JSON,要记住:集合中不要放集合,要构建对象来放集合,这样才能在绑定数据时调用 反序列化推荐用json.net这个开源库,引用时注意要用WinRt中的json.dll 然后用Root r=JsonConvert.Deser