【Unity】Jenkins自动打包入门小结

目录

一、下载并安装Jenkins

二、使用Jenkins

三、扩展功能

3.1 PS：关于构建后操作，例如构建后发消息给QQ邮箱参考：

3.2 需要修改jenkins输出工作目录（默认是C盘的.jenkins）【安装包形式下载Jenkins，若非安装包形式是找不到这个目录的】（选看）

四、常见报错

五、密码失效问题

六、日志乱码问题

---

一、下载并安装Jenkins

Unity和Jenkins真是绝配，将打包彻底一键化！ - wuzhang - 博客园 （参考资料）

Jenkins download and deployment  （官网下载地址）

下载Index of /war/2.346下的jenkins.war文件【注意Jenkins和Tomcat版本均要匹配上JDK1.8(Java 8)版本】

将jenkins.war包放入Tomcat的webapps 目录下，点击bin/startup.bat 启动Tomcat

镜像地址：Index of apache-local/tomcat 

 配置路径：

 CATALINA_HOME

Path路径新增：%CATALINA_HOME%\bin

测试：打开cmd 执行startup

二、使用Jenkins

（1）登录Jenkins

http://localhost:8080/jenkins

注意：本文使用是tomcat+jekins.war包形式配置Jenkins环境，非Jenkins安装包形式，其.jenkins目录生成路径会有所不同，若是安装包形式的话，默认会在C:\Windows\ServiceProfiles\LocalService\.jenkins

可修改工作空间（存放Jenkins打包相关输出的目录）：C:\Users\lenovo\.jenkins\config.xml内容：
<workspaceDir>E:/JenkinsFile/workspace/${ITEM_FULL_NAME}</workspaceDir>
原本会放于C:\Users\lenovo\.jenkins\workspace（C盘）

后续自己设置好就可以开始用了。

关于插件可进行离线下载：Index of /download/plugins 

支持镜像：Index of /jenkins/plugins/ | 清华大学开源软件镜像站 | Tsinghua Open Source Mirror  

可更换镜像下载地址：https://mirrors.tuna.tsinghua.edu.cn/jenkins/updates/update-center.json

位于Manage Jenkins -> Manage Plugins -> Advanced 最下面设置Update Site镜像地址

 

 

需要下载的插件文件: 

Unity3d下载1.3版本
Unity3dDownload previous versions of Unity3dhttp://updates.jenkins-ci.org/download/plugins/unity3d-plugin/

Gradle 下载1.5版本

GradleDownload previous versions of Gradlehttps://updates.jenkins-ci.org/download/plugins/gradle/若有其他请自行查找，如果下载慢可以使用镜像，网上找有很多，上面也提供了1个。

（注意下面的Jenkins页面风格和你们不一样也是正常的，最好切成英文模式针对性看，因为下面版本是很久以前Jenkins版本，具体我也忘了）

（2）使用Jenkins构建第一个任务：打包Android、Window应用程序。

参考文章：Jenkins基于unity的自动化打包_很帅的友人的博客-CSDN博客_jenkins unity打包

注意：上方2个参数Platform是选项，BuildPath是String，添加参数的时候可以选类型的，如下图。

在Jenkins中用'$'符号+参数名称来获取其值，如上方BuildPath的默认值为：

E:\jenkins\workspace\第一个Jenkins任务\$Platform\MatchGame ，其中有$Platform ，它是获取了Platform参数的值，在下面你会看到打包路径会有2个文件夹分别是：Android和Window64，关于IOS为什么不打包因为我是Window系统电脑。

2022年7月24日更新补充 ：
若没有找到Invoke Unity3d Editor选项，则需要下载一个Jenkins插件：Unity3d

 

如果没有搜索出来，可将unity3d改Unity3d，这个搜索有时候会失灵。

问题二：为什么没有Unity选项？需要全到Jenkins全局配置里设置Unity目录才行。

-quit -batchmode -projectPath D:\下载文件\游戏蛮牛源码\一个消消乐工程 -executeMethod UnityProjectBuilder.CommandLineBuild -logFile JenkinsBuildUnity.log Platform-$Platform BuildPath-$BuildPath

下面解释上方那一串关键的字符串：

D:\下载文件\游戏蛮牛源码\一个消消乐工程 是工程根目录，要改成你要打包的工程根目录

UnityProjectBuilder.CommandLineBuild 是存放于Editor文件夹的一个脚本上的静态方法，如下C#脚本：

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class UnityProjectBuilder
{

    static string[] GetBuildScenes()
    {
        List<string> names = new List<string>();

        foreach (EditorBuildSettingsScene e in EditorBuildSettings.scenes)
        {
            if (e == null)
                continue;

            if (e.enabled)
                names.Add(e.path);
        }
        return names.ToArray();
    }

    /// <summary>
        /// 此方法是从jienkins上接受  数据的 方法
        /// </summary>
    static void CommandLineBuild()
    {
        try
        {

            Debug.Log("Command line build\n------------------\n------------------");
            string[] scenes = GetBuildScenes();
            //string path = @"E:\Unity游戏包\Android\消消乐游戏";//这里的路径是打包的路径， 定义
            string path = GetJenkinsParameter("BuildPath");
            Debug.Log(path);
            for (int i = 0; i < scenes.Length; ++i)
            {
                Debug.Log(string.Format("Scene[{0}]: \"{1}\"", i, scenes[i]));
            }
            // ProjectPackageEditor.BuildByJenkins(GetJenkinsParameter("Platform"), GetJenkinsParameter("AppID"), GetJenkinsParameter("Version"), GetJenkinsParameter("IPAddress"));
            Debug.Log("Starting Build!");
            Debug.Log(GetJenkinsParameter("Platform"));

            string platform = GetJenkinsParameter("Platform");
            if (platform == "Android")
            {
                BuildPipeline.BuildPlayer(scenes, path + ".apk", BuildTarget.Android, BuildOptions.None);
            }
            else if (platform == "IOS")
            {
                //BuildPipeline.BuildPlayer(scenes, path, BuildTarget.iOS, BuildOptions.AcceptExternalModificationsToPlayer);
            }
            else if(platform == "Window64")
            {
                BuildPipeline.BuildPlayer(scenes, path + ".exe", BuildTarget.StandaloneWindows64, BuildOptions.None);
            }
        }
        catch (Exception err)
        {
            Console.WriteLine("方法F中捕捉到：" + err.Message);
            throw;//重新抛出当前正在由catch块处理的异常err
        }
        finally
        {
            Debug.Log("---------->  I am copying!   <--------------");
        }
    }


    /// <summary>
    ///解释jekins 传输的参数
    /// </summary>
    /// <param name="name"></param>
    /// <returns></returns>
    static string GetJenkinsParameter(string name)
    {
       /*下面是解析这个字符串，用空格分隔，每一个arg是空格分隔后的字符串，然后继续解析出Platform参数和BuildPath参数，
注意：$BuildPath是我们Jenkins上定义的参数，它会传入一个字符串路径
-quit -batchmode -projectPath D:\下载文件\游戏蛮牛源码\一个消消乐工程 -executeMethod UnityProjectBuilder.CommandLineBuild -logFile JenkinsBuildUnity.log Platform-$Platform BuildPath-$BuildPath
*/
        foreach (string arg in Environment.GetCommandLineArgs())
        {
            Debug.Log("arg:" + arg);
            if (arg.StartsWith(name))
            {
                return arg.Split("-"[0])[1];
            }
        }
        return null;
    }
}

JenkinsBuildUnity.log 是构建日志文件名带后缀，它会存放于当前任务（第一个Jenkins任务）文件夹下

其中，这个第一个Jenkins任务文件夹是创建任务时自动创建的，其他2个文件夹是我打包出的Android应用程序包和Window应用程序包所在文件夹。

最后构建我们的工程吧！

等等，先把需要构建的Unity关掉，不然构建会失败！

若构建失败，可以看构建日志上方说到的JenkinsBuildUnity.log

构建成功后，就会多出相应的文件夹里面就存放着应用程序包了！

三、扩展功能

3.1 PS：关于构建后操作，例如构建后发消息给QQ邮箱参考：

Unity和Jenkins真是绝配，将打包彻底一键化！ - wuzhang - 博客园

需要开启QQ的SMTP，怎么开启可百度获知，因为我开通不了手机问题，所以就没有学这部分。

3.2 需要修改jenkins输出工作目录（默认是C盘的.jenkins）【安装包形式下载Jenkins，若非安装包形式是找不到这个目录的】（选看）

 这样子它的日志文件才会输出到对应的我们构建时指定的打包地方。

修改后需要重启Jenkins，并且重新进Jenkins网址时会要求去从到新的工作目录取到密码，填入，以及新的一些插件的安装，比如Unity那个也是，全部都要重新来一遍。（PS：可以不去改JENKINS_HOME目录，改了的话肯定整个Jenkins目录都会在最新的地方创建，旧的数据不会自动迁移，需要手动迁移，可以尝试去找到类似workspace的字段并修改即可）

四、常见报错

打包apk没看到.apk文件，即使它是成功的，查看.log日志发现
* What went wrong:
Execution failed for task ':launcher:mergeReleaseResources'.
> 8 exceptions were raised by workers:
  com.android.builder.internal.aapt.v2.Aapt2InternalException: AAPT2 aapt2-3.4.0-5326820-windows Daemon #2: Daemon startup failed
  This should not happen under normal circumstances, please file an issue if it does.
  com.android.builder.internal.aapt.v2.Aapt2InternalException: AAPT2 aapt2-3.4.0-5326820-

解决方法：全局参数配置gradle目录路径（与Unity内一致即可）

GRADLE_USER_HOME 【必须是这个名字】
D:/Unity 2019.4.0f1/Unity/Editor/Data/PlaybackEngines/AndroidPlayer/Tools/gradle

若还有报错说明，SDK和APK的路径也要配置，可以去我的电脑查看高级配置 查看路径的别名和内容，都照样填写。

除此之外还有

 

Unity 2019.4 默认使用 3.4.0 版本的gradle。

五、密码失效问题

密码是C:\Users\lenovo\.jenkins\secrets\initialAdminPassword文件管理的，如果找不到这个文件了，说明被误删或被顶替掉了，目前我发现只有当你去新下载一个Jenkins时才会发生，如果没了可以尝试创个同名文件 填入密码。

我发生这个问题主要是因为我之前用的是安装包形式安装Jenkins，这次使用了jenkins.war形式+tomcat，新的安装形式会直接将旧的密码文件给删了！所以有必要说明下，找老半天以为发生啥事情，每次下的Jenkins估计都会清掉密码重新让你设置 并不会保留之前的。

六、日志乱码问题

环境系统变量新增
变量名：JAVA_TOOL_OPTIONS
变量值： -Dfile.encoding=UTF-8
D:\Program Files\Apache Software Foundation\Tomcat 9.0\conf\server.xml
打开编辑，新增useBodyEncodingForURI="true"
<Connector port="8080" useBodyEncodingForURI="true" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443"
               maxParameterCount="1000"
               />

Jenkins环境变量：
LANG
zh_CN.UTF-8