Skip to content

Latest commit

 

History

History
334 lines (270 loc) · 16.5 KB

README.md

File metadata and controls

334 lines (270 loc) · 16.5 KB
Raw

厌倦了每次都得在不同的打包机配置Android打包环境？

厌倦了不同打包环境带来的问题？

厌倦了学习？（那就放下手机出门去大自然散散步，下面的你不用看了）

确实厌倦了，公司的项目一直是每个项目单独配一个打包机，每次配置环境都十分难受，之前一直是实体机器，后来转到了虚拟机，搭配Docker正好合适，于是乎花费了一番功夫搭建了一个基于Docker+Jenkins pipeline的打包环境。

参考的是medium上的一篇文章，大体步骤如下：

  1. 安装Docker
  2. 安装并运行jenkins镜像
  3. 自己build一个封装了安卓sdk、jdk、python、git环境的镜像
  4. 在前一步的基础上增加安卓模拟器

我舍弃了第四步并且在第三步的基础上增加了一点修改：增加字节的AabResGuard和bundletool，方便打aab时做资源混淆和转apks测试。当然你也可以去docker hub找一个现成的镜像，更方便，比如etlegacy/android-build这个。

Github项目地址 AndroidPipeline

安装Docker

linux上一般在命令行装即可，Docker官方和国内daoclound都提供了一键安装的脚本。 官方的一键安装方式：

curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun

国内daoclound一键安装命令：

curl -sSL https://get.daocloud.io/docker | sh

参考资料： Linux安装Docker完整教程

安装并运行jenkins

安装：

docker pull jenkins/jenkins:latest

运行：

docker run -d -u root -v jenkins_home:/var/jenkins_home -v /var/run/docker.sock:/var/run/docker.sock -p 8080:8080 -p 50000:50000 --restart=on-failure --name jenkins jenkins/jenkins
  • -d 表示运行在后台
  • -u root 表示运行该容器在root user下
  • -v jenkins_home:/var/jenkins_home 创建一个jenkins_home目录与容器内的/var/jenkins_home映射
  • -v /var/run/docker.sock:/var/run/docker.sock 链接docker socket，允许容器与docker daemon通信
  • -p 8080:8080 -p 50000:50000 端口映射，方便宿主访问到jenkins网页
  • --restart=on-failure 遇错自动重启
  • --name jenkins jenkins/jenkins 容器名字

容器内安装docker：

  1. 进入容器环境
docker exec -u root -it jenkins bash
  1. 安装docker
apt-get update
apt-get install -y docker.io

这个时候如果你在容器环境运行docker ps命令，显示的结果会跟在宿主运行显示的结果一致。

  1. 配置jenkins账号密码 特别要注意安装好Docker Pipeline这个插件！！不然无法使用下面的镜像。

android-build镜像

编写Dockerfile配置jdk、android sdk等环境，这是最重要的一步，所以会详细展开。

完整代码

地基

主要是定义ANDROID_HOME、JAVA_HOME的目录，apt安装一些必要的包（如python和git）。

FROM ubuntu:22.04
# 定义android sdk目录
ENV ANDROID_HOME="opt/android-sdk"

# support amd64 and arm64
# 设置jdk环境变量
RUN JDK_PLATFORM=$(if [ "$(uname -m)" = "aarch64" ]; then echo "arm64"; else echo "amd64"; fi) && \
    echo export JDK_PLATFORM=$JDK_PLATFORM >> /etc/jdk.env && \
    echo export JAVA_HOME="/usr/lib/jvm/java-11-openjdk-$JDK_PLATFORM/" >> /etc/jdk.env && \
    echo . /etc/jdk.env >> /etc/bash.bashrc && \
    echo . /etc/jdk.env >> /etc/profile

此处省略若干代码...

Android SDK

主要是SDK和platform tools的安装，还要解决一个liscense的问题。我装的是Android 33，因为现在基本都是targetSdk 33。

# 删除安装临时文件
RUN rm -rf /tmp/* /var/tmp/*

# 设置环境变量
ENV ANDROID_SDK_HOME="$ANDROID_HOME"
ENV PATH="$JAVA_HOME/bin:$PATH:$ANDROID_SDK_HOME/emulator:$ANDROID_SDK_HOME/tools/bin:$ANDROID_SDK_HOME/tools:$ANDROID_SDK_HOME/platform-tools:"

# Get the latest version from https://developer.android.com/studio/index.html
ENV ANDROID_SDK_TOOLS_VERSION="8512546_latest"
ENV ANDROID_CMD_DIRECTORY="$ANDROID_HOME/cmdline-tools/latest"

# 安装 Android Toolchain
RUN echo "sdk tools ${ANDROID_SDK_TOOLS_VERSION}" && \
    wget --quiet --output-document=sdk-tools.zip \
    "https://dl.google.com/android/repository/commandlinetools-linux-${ANDROID_SDK_TOOLS_VERSION}.zip" && \
    mkdir --parents "$ANDROID_HOME/cmdline-tools" && \
    unzip sdk-tools.zip -d "$ANDROID_HOME/cmdline-tools" && \
    mv "$ANDROID_HOME/cmdline-tools/cmdline-tools" $ANDROID_CMD_DIRECTORY && \
    rm --force sdk-tools.zip

# Install SDKs
# The `yes` is for accepting all non-standard tool licenses. 自动接受licenses
RUN mkdir --parents "$ANDROID_HOME/.android/" && \
    echo '### User Sources for Android SDK Manager' > \
    "$ANDROID_HOME/.android/repositories.cfg" && \
    . /etc/jdk.env && \
    yes | "$ANDROID_CMD_DIRECTORY"/bin/sdkmanager --licenses > /dev/null

# 安装需要的sdk版本 android-33
# https://developer.android.com/studio/command-line/sdkmanager.html
RUN echo "platforms" && \
    . /etc/jdk.env && \
    yes | "$ANDROID_CMD_DIRECTORY"/bin/sdkmanager \
    "platforms;android-33" > /dev/null

RUN echo "platform tools" && \
    . /etc/jdk.env && \
    yes | "$ANDROID_CMD_DIRECTORY"/bin/sdkmanager \
    "platform-tools" > /dev/null

RUN echo "build tools 33" && \
    . /etc/jdk.env && \
    yes | "$ANDROID_CMD_DIRECTORY"/bin/sdkmanager \
    "build-tools;33.0.0" > /dev/null

安卓sdk放/opt这个目录，默认是没有写入权限的，如果你想打debug包且没有配置签名，AS会自动帮你生成一个debug.keystore，这个时候没有写入权限会导致打包报错，解决方法可以更改sdk目录或者在Dockerfile中加入生成debug.keystore的步骤。

# generate debug keystore
RUN keytool -genkey -v dname "cn=Test Android, ou=Test, o=Star Man, c=CN" -alias androiddebugkey -keyalg RSA -keysize 2048 -validity 9125 -keystore $ANDROID_HOME/.android/debug.keystore -storepass android -keypass android

AabResguard和bundletool

资源混淆可以减少安装包体积和加固app，不建议使用gradle plugin的方式引入，一是需要适配gradle版本，二是不够灵活，因此使用命令行的方式来进行混淆。下载AabResguard0.1.10和bundletool1.15.2并解压到aabresguard目录。

RUN mkdir -p $ANDROID_HOME/aabresguard
RUN curl -L https://github.com/martinloren/mvn-repo/raw/AabResGuard_0.1.10.zip -o $ANDROID_HOME/aabresguard/AabResGuard_0.1.10.zip
RUN unzip $ANDROID_HOME/aabresguard/AabResGuard_0.1.10.zip -d $ANDROID_HOME/aabresguard
RUN curl -L https://github.com/google/bundletool/release/download/1.15.2/bundletool-all-1.15.2.jar -o $ANDROID_HOME/aabresguard/bundletool.jar

至此，Dockerfile主要部分完成，可以开始构建镜像了，一行命令搞定。

# 我的Dockerfile为Dockerfile.prod，因此需要指定
docker build -f Dockerfile.prod -t android-build:1.0 .

dockerbuild.PNG build成功之后就可以通过docker run 来运行这个镜像，不过我们是配合jenkins pipeline使用，接着看pipeline怎么写。

Jenkins pipeline

语法也比较简单，参考教程即可。

语法参考

比较重要的一步是pipeline中的agent使用docker，镜像是我们构建的android-build:1.0。

pipline {
    agent {
        docker { 
            image 'android-build:1.0'
            args ''
        }
    }
    ...
}

完整代码

构建参数我分为多个，为了灵活控制打包流程，比如设置了一个aab_obfuscate参数控制是否开启aab混淆，其它的则是常见的版本名版本号、打包类型、flavor等。

pipeline {
    parameters {
        string(name: 'version_name', defaultValue: '1.0.0', description: 'app version name')
        string(name: 'version_code', defaultValue: '1', description: 'app version code')
        choice(name: 'type', choices: 'Release\nDebug', description: 'build type')
        choice(name: 'file_type', choices: 'apk\naab', description: 'aab or apk')
        choice(name: 'flavor', choices: 'product\ndev', description: 'Dev or Product flavor')
        booleanParam(name: 'aab_obfuscate', defaultValue: true, description: '是否混淆 aab 包的资源文件')
        booleanParam(name: 'archiveArtifacts', defaultValue: false, description: '是否归档本次构建产物')
    }
}

环境变量设置了签名的路径，aab资源混淆的白名单路径，钉钉的webhook。

pipeline {
        environment {
        DIR = "${WORKSPACE}"
        SIGN_FILE = "$DIR/app/key/Signing.jks"
        STORE_PASS = "SixSix"
        KEY_ALIAS = "SixSix"
        KEY_PASS = "SixSix"
        AAB_RES_CONFIG_PATH = "$DIR/aab_res_guard_cfg.xml"
        WEBHOOK = "https://oapi.dingtalk.com/robot/send?access_token="
        KEYWORD = "DingdingKeyword"
    }
}

整个pipeline分为三个stage: Checkout、Build、Notify，言简意赅。

Checkout阶段使用了Jenkins的片段生成器生成了一段从SVN拉取代码的代码。

stage('Checkout') {
    steps{
        // svn 拉代码
        checkout([$class: 'SubversionSCM', additionalCredentials: [], excludedCommitMessages: '', excludedRegions: '', excludedRevprop: '', excludedUsers: '', filterChangelog: false, ignoreDirPropChanges: false, includedRegions: '', locations: [[cancelProcessOnExternalsFail: true, credentialsId: 'username', depthOption: 'infinity', ignoreExternalsOption: true, local: '.', remote: 'your svn repository']], quietOperation: true, workspaceUpdater: [$class: 'UpdateUpdater']])    
    }
}

Build阶段主要使用gradlew配合控制参数编译apk/aab、混淆aab资源、生成apks、档输出产物。

stage('Build') {
    steps {
        script {
            def taskNamePrefix = params.file_type.equals("aab") ? "bundle" : "assemble"
            def taskName = "${taskNamePrefix}${params.flavor}${params.type}"

            sh 'chmod +x ./gradlew'
            // sh 'sudo chmod +w /opt/android-sdk/.android'
            if(params.file_type.equals('aab')) {
                // 删除旧的编译产物
                sh "rm -rf $DIR/app/build/outputs/bundle/${params.flavor}${params.type}/"
            }
            // 编译
            sh "./gradlew -Dorg.gradle.daemon=true -Dorg.gradle.jvmargs=-Xmx4096m -Dfile.encoding=utf-8 :app:${taskName} -PVERSION_NAME=${params.version_name} -PVERSION_CODE=${params.version_code}
            
            if(params.file_type.equals('aab') && params.aab_obfuscate == true) {
                // 混淆资源
                def outputPath = "$DIR/app/build/outputs/bundle/${params.flavor}${params.type}/"
                def aabName = "${params.flavor}-${params.type}-${params.version_name}-${params.version_code}"

                def aabPath = "${outputPath}${aabName}.aab"
                echo "start mv aab name"
                sh "mv ${outputPath}/*.aab ${aabPath}"
                echo "finish mv aab name"
                // 混淆aab资源
                echo "开始混淆aab资源"
                sh "java -jar /opt/android-sdk/aabresguard/com/bytedance/android/aabresguard-core/0.1.10/aabresguard-core-0.1.10.jar obfuscate-bundle --bundle=${aabPath} --output=${outputPath}obfuscated-${aabName}.aab --config=${AAB_RES_CONFIG_PATH} --merge-duplicated-res=false --storeFile=${env.SIGN_FILE} --storePassword=${env.STORE_PASS} --keyAlias=${env.KEY_ALIAS} --keyPassword=${env.KEY_PASS}"
                // 构建apks
                sh "java -jar /opt/android-sdk/aabresguard/bundletool.jar build-apks --bundle ${aabPath} --output=${outputPath}/obfuscated-${aabName}.apks --ks=${env.SIGN_FILE} --ks-pass=pass:${env.STORE_PASS} --ks-key-alias=${env.KEY_ALIAS} --key-pass=pass:${env.KEY_PASS}"
                // 归档
                if(params.archiveArtifacts) {
                    archiveArtifacts artifacts: "app/build/outputs/bundle/${params.flavor}${params.type}/*.aab", fingerprint: true
                    archiveArtifacts artifacts: "app/build/outputs/bundle/${params.flavor}${params.type}/*.apks", fingerprint: true
                    archiveArtifacts artifacts: "app/build/outputs/bundle/${params.flavor}${params.type}/*.txt", fingerprint: true
                }
            }
        }
    }
}

Notify阶段进行钉钉通知，定义一个dingding函数，参数是通知内容，封装发送到钉钉机器人的逻辑。

import groovy.json.JsonOutput

def dingding(String msg) {
    def dingTalkMessage = JsonOutput.toJson([
        msgtype: 'text',
        text: [
            content: "${env.KEYWORD} ${msg}"
        ]
    ])
    def curlCommand = """
    curl '${env.WEBHOOK}' -H 'Content-Type: application/json' -d '${dingTalkMessage}' 
    """
    sh curlCommand
}

pipeline {
    stage('Notify') {
        steps{
            script {
                def folder = params.file_type == "apk" ? "apk" : "bundle"
                def path = params.file_type == "apk" ? "${params.flavor}/${params.type.toLowerCase()}/" : "${params.flavor}${params.type}/"
                def content = "your content"

                dingding("打包成功 \n 下载地址: ${content}")
            }
        }
    }
    post {
        failure {
            script {
                // 获取一百条日志
                def log = currentBuild.rawBuild.getLog(100)
                dingding("打包失败\n${log}")
            }
        }
    }
}

还有一个重要步骤：如果你不设置GRADLE_USER_HOME，那么gradle默认下载的目录是在/root/.gradle，然后每次pipeline执行完都会把android-build容器删除，因此gradle也被删除了，导致每次build都要下载一遍，结局人方法也很简单，到jenkisn-系统管理-系统配置-新增一个环境变量(GRADLE_USER_HOME)，值跟jenkins工作目录相同即可。

截屏2024-07-11 16.11.06.png

至此，万事俱备，只欠东风，运行一遍pipeline，也许你会遇到一个权限报错：Got permission denied while trying to connect to the Docker daemon，可参考解决方案。

再次提醒，如果你的报错提示 Invalid agent type "docker"，则速去安装Docker pipeline这个插件即可在pipeline中使用Docker容器。

运行效果：

jenkins.PNG

参考

How to build a CI/CD Pipeline for Android with Jenkins and Docker— Part 1

Evolving our Android CI to the Cloud (2/3): Dockerizing the Tasks