美文网首页Android MGO开发Android知识Android开发
我是如何将Pluto作为library分享到jCenter

我是如何将Pluto作为library分享到jCenter

作者: minggo | 来源:发表于2017-03-12 23:52 被阅读70202次

    最近小明正在看一本名叫《历代经济变革得失》从历史角度分析经济变化的书。通过研究经济方式,作为一个工科毕业的小明,当然直接想到是数据统计,建立数学理论模型,这本书入手方式就成为了第一个吸引点。除了耳熟能详的历史事件人物,阶级的斗争之外,留下深刻印象的还是封闭专制和开放改革之间的博弈。彰显出活力生态,Open和Share是一个很好的选择。
    上个月27号开源Pluto框架《我的开源Android开发框架Pluto》,得到客观上多正面的反馈。至此,进入这次主观上的第二步,将Pluto变的更容易使用--将Pluto作为library分享到jCenter。

    文章结构

    一.文章价值

    1、实现我的框架Pluto分享到jCenter,以后开发直接用一句gradle语句就可以使用框架。
    2、严格参照我的实现步骤,就不用在其他blog一篇篇阅读总结踏坑才实现自己的library分享。

      dependencies {
          compile 'com.minggo:Pluto:1.0'
      }
    

    其中,bintray.com要熟悉,要不要翻墙?不用;Gradle配置要分清楚配置library的Gradle还是Project Gradle;编译和上传要多久?编译保证不出错就行,上传普遍是1分钟;link to jCenter审核要多久,我的是3个小时。

    二.bintray账号设置

    1.新官网整体认知

    注册登录后的页面

    其中“View Profile”是个人中心,下边会介绍获取appkey."Add New Organization"是添加组织,这个比较重要,为了保证顺利上传,手动配置自己Organization更为合适。

    2.添加组织

    1)选择创建新组织
    选择创建新组织
    2)根据填写组织相关信息,主要完成带星的填写就行
    填写组织信息
    3)查看创建完成的组织页面
    组织管理页面

    3.创建创库

    手动配置自己的仓库尤为重要,注意创库名。因为pluto仓库名将会在Gradle文件中做关联,type选Maven主要针对本文实现的方式,必须选择。关于版权License选择是个可选选项,我的Pluto项目在github上创建的时候就选择了MIT,所以就选择MIT。创库描述也是一个可选填写,我就把Pluto在github上的描述添加上去了。

    创建仓库

    在组织页面下就可以看见一下仓库,需要了解可以点击去看看。

    仓库Pluto.png

    4.获取自己的apikey

    依次点击页面“Edit Profile”-->"API Key" -->"Show",最好先复制存下来,等下gradle配置用到。


    获取appkey

    三.Gradle配置

    1.整体要留意的3个地方

    第一处,Project的gradle用来配置maven和bintray插件用的;第二处,Library的gradle用来配置版本、仓库等等用的;第三处,local.properties用来配置bintray的账号和apikey用的。那么关键内容将会在Library的gradle中。


    准备改动一下3个地方

    2.Project的Gradle配置maven和bintray插件

    找到Project的Gradle文件,在dependencies 中添加一下两句插件路径

    dependencies {
        //Gradle Android Maven plugin
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.4.1'
        //Gradle Bintray Plugin
        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.1'
    }
    

    更详细的Gradle Android Maven pluginGradle Bintray Plugin

    3.local.properties的账号和appkey配置

    找到local.properties文件

    bintray.user=minggo620 // bintray用户名
    bintray.apikey=ab02158f80eaa139423axxxxxxxxxx //bintray API KEY
    

    之前复制下来的apikey派上用场了,粘贴到local.properties文件后边。为什么放在这个文件原因是项目.gitignore文件默认忽略这个文件上传,正好免除暴露key。

    4.Library的Gradle配置

    找到Library的Gradle文件,进行一下配置

    1)引用Maven和bintray插件

    头部加上

    apply plugin: 'com.jfrog.bintray'
    apply plugin: 'com.github.dcendents.android-maven'
    
    2)读取local.properties文件

    头部加上接上

    Properties properties = new Properties()
    properties.load(project.rootProject.file('local.properties').newDataInputStream())
    
    3)配置必要和可选常量

    比如最终形式是 compile 'com.minggo:Pluto:1.0'那么group和version如下。至于Pluto是Library的名称,在执行任务中会配置。

    def siteUrl = 'https://github.com/minggo620/Pluto-Android'   // 项目的主页
    def gitUrl = 'https://github.com/minggo620/Pluto-Android.git'   // Git仓库的url
    
    version = "1.0"
    group = "com.minggo"
    

    4)配置bintray配对任务

    以下写有注释的都要注意,特别是repo的值是自己创建的仓库名称不是仓库类型,name写是Library名称。license只能写bintray提供选择类型,userOrg填写bintray后台创建organization。强调这个的原因是本人看了其他文章发现容易产生误解的地方。

    bintray {
        user = properties.getProperty("bintray.user")
        key = properties.getProperty("bintray.apikey")
        pkg {
            repo = 'pluto'//自己bintray创建仓库名字
            name = 'Pluto'//Library的名字
            websiteUrl = siteUrl
            vcsUrl = gitUrl
            licenses = ['MIT']//不能随便写,只能是仓库创建时选择的license type
            userOrg = 'minggoopen' //自己bintray创建的organization名称
            publish = true // 是否是公开项目。
    
            version {
                name = '1.0'
                desc = 'High integrated development framework for Android applications.'
                released  = new Date()
                vcsTag = 'v1.0'
                attributes = ['gradle-plugin': 'com.use.less:com.use.less.gradle:gradle-useless-plugin']
             }
        }
        configurations = ['archives']
    }
    
    5)配置maven的Install任务

    这个部分重要的就会生成POM.xml,如果没有执gradlew install就执行Studio 中Gradle栏的publishing下bintrayUpload会提示,没有默认default pom.xml。

    install {
        repositories.mavenInstaller {
            // This generates POM.xml with proper parameters
            pom {
                project {
                    packaging 'aar'
                    // Add your description here
                    name 'Pluto Android'
                    description 'High integrated development framework for Android applications.'
                    url siteUrl
                    // Set your license
                    licenses {
                        license {
                            name 'MIT'
                            url 'https://raw.githubusercontent.com/minggo620/Pluto-Android/master/LICENSE'
                        }
                    }
                    developers {
                        developer {
                            id 'minggo620'        //填写bintray或者github的用户名
                            name 'minggo'         //姓名,可以是中文
                            email 'minggo8en@gmail.com'
                        }
                    }
                    scm {
                        connection gitUrl
                        developerConnection gitUrl
                        url siteUrl
                    }
                }
            }
        }
    }
    
    6)配置源码和文档任务

    记得在以下响应地方添加 failOnError false,否则出现install执行出现build failed。

    task sourcesJar(type: Jar) {
        from android.sourceSets.main.java.srcDirs
        classifier = 'sources'
    }
    task javadoc(type: Javadoc) {
        failOnError false //必须添加以免出错
        source = android.sourceSets.main.java.srcDirs
        classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    }
    task javadocJar(type: Jar, dependsOn: javadoc) {
        classifier = 'javadoc'
        from javadoc.destinationDir
    }
    artifacts {
        archives javadocJar
        archives sourcesJar
    }
    
    7)这是我Library的Gradle完整配合
    apply plugin: 'com.android.library'
    apply plugin: 'android-apt'
    apply from: "dependencies.gradle"
    apply plugin: 'com.jfrog.bintray'
    apply plugin: 'com.github.dcendents.android-maven'
    
    def siteUrl = 'https://github.com/minggo620/Pluto-Android'   // 项目的主页
    def gitUrl = 'https://github.com/minggo620/Pluto-Android.git'   // Git仓库的url
    Properties properties = new Properties()
    properties.load(project.rootProject.file('local.properties').newDataInputStream())
    
    version = "1.0"
    group = "com.minggo"
    
    android {
        compileSdkVersion 23
        buildToolsVersion "24.0.3"
        defaultConfig {
            minSdkVersion 14
            targetSdkVersion 23
            versionCode 1
            versionName "1.0"
            consumerProguardFiles 'proguard-rules.pro'
        }
        buildTypes {
            release {
                minifyEnabled false
            }
        }
    }
    bintray {
        user = properties.getProperty("bintray.user")
        key = properties.getProperty("bintray.apikey")
        pkg {
            repo = 'pluto'//自己bintray创建仓库名字
            name = 'Pluto'//Library的名字
            websiteUrl = siteUrl
            vcsUrl = gitUrl
            licenses = ['MIT']//不能随便写,只能是仓库创建时选择的license type
            userOrg = 'minggoopen' //自己bintray创建的organization名称
            publish = true // 是否是公开项目。
    
            version {
                name = '1.0'
                desc = 'High integrated development framework for Android applications.'
                released  = new Date()
                vcsTag = 'v1.0'
                attributes = ['gradle-plugin': 'com.use.less:com.use.less.gradle:gradle-useless-plugin']
            }
        }
        configurations = ['archives']
    }
    
    install {
        repositories.mavenInstaller {
            // This generates POM.xml with proper parameters
            pom {
                project {
                    packaging 'aar'
                    // Add your description here
                    name 'Pluto Android'
                    description 'High integrated development framework for Android applications.'
                    url siteUrl
                    // Set your license
                    licenses {
                        license {
                            name 'MIT'
                            url 'https://raw.githubusercontent.com/minggo620/Pluto-Android/master/LICENSE'
                        }
                    }
                    developers {
                        developer {
                            id 'minggo620'        //填写bintray或者github的用户名
                            name 'minggo'         //姓名,可以是中文
                            email 'minggo8en@gmail.com'
                        }
                   }
                    scm {
                        connection gitUrl
                        developerConnection gitUrl
                        url siteUrl
                    }
                }
            }
        }
    }
    task sourcesJar(type: Jar) {
        from android.sourceSets.main.java.srcDirs
        classifier = 'sources'
    }
    task javadoc(type: Javadoc) {
        failOnError false
        source = android.sourceSets.main.java.srcDirs
        classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    }
    task javadocJar(type: Jar, dependsOn: javadoc) {
        classifier = 'javadoc'
        from javadoc.destinationDir
    }
    artifacts {
        archives javadocJar
        archives sourcesJar
    }
    

    四.执行install和upload

    window和mac命令有些不一样,mac命令前边加./再敲命令。以下是window执行方式。

    1.确保Gradle已经安装

    在studio中 Terminal中执行查看安装情况,如果没有会自动安装。

    gradlew -v
    

    安装情况如下:


    Gradle安装情况
    2.执行install任务
    gradlew install
    

    结果如下:

    :Pluto:bundleRelease UP-TO-DATE
    :Pluto:javadoc UP-TO-DATE
    :Pluto:javadocJar UP-TO-DATE
    :Pluto:sourcesJar UP-TO-DATE
    :Pluto:install                 
              
    BUILD SUCCESSFUL
    
    3.执行upload任务
    gradlew bintrayUpload
    

    1分钟后结果如下:

    :Pluto:install
    :Pluto:bintrayUpload
    
    BUILD SUCCESSFUL
    
    Total time: 1 mins 33.999 secs
    

    五.Link to jCenter

    进入bintray的Organization仓库管理后台找到自己的对应的仓库发现一个package如下图

    Paste_Image.png

    进入Package进行看到上传后的结果以下两个红色框框关键信息


    Pluto上传后

    如果是未发布将会出现一下link提示,这时就可以点击提交审核了。


    Paste_Image.png

    完成这一步剩下的就是邮箱等待了。3个小时后...

    Paste_Image.png

    六.文章总结

    就这样,我的Android开发框架Puto做了Library分享到了jCenter。以后每次更新就只需要修改gradle的compile 'com.minggo:Pluto:1.0'。对于使用Pluto框架的开发者来说就不必再去github下载源码拷贝到自己的项目,想必是一件很cool的事。是否,也有了分享自己的Library到JCenter的冲动了?
    Gradle配置和Pluto框架gitHub下载地址https://github.com/minggo620/Pluto-Android

    微信公众号:minggo_dev
    【原创出品 未经授权 禁止转载】
    【欢迎微友分享转发 禁止公号等未经授权的转载】

    相关文章

      网友评论

      本文标题:我是如何将Pluto作为library分享到jCenter

      本文链接:https://www.haomeiwen.com/subject/nccxnttx.html