Unity打iOS包之xcodeapi的使用

xcodeapi

我们在用Unity打包iOS的时候&＃xff0c;经常需要自动化设置导出工程的各项配置&＃xff0c;比如证书名、TeamId、mobileprovision文件等等。

在Unity 4.x时代&＃xff0c;常用的工具是XUPorter&＃xff08;原作者已不再维护&＃xff0c;如果坚持要用&＃xff0c;可以从github上下载&＃xff1a;https://github.com/onevcat/XUPorter&＃xff09;

在Unity 5.x之后&＃xff0c;Unity官方提供了另外一套工具&＃xff0c;叫做xcodeapi&＃xff0c;因为是官方维护的&＃xff0c;所以在使用上可以更放心&＃xff0c;所以推荐使用。

xcodeapi的工程链接在Unity的开源bitbucket上&＃xff1a;https://bitbucket.org/Unity-Technologies/xcodeapi

上面这个链接貌似失效了&＃xff0c;我传了一份到GitHub上&＃xff0c;可以从GitHub中下载xcodeapi&＃xff1a;https://github.com/chenpindong/XcodeAPI

如果访问GitHub比较卡&＃xff0c;也可以访问CODE.CHINA&＃xff0c;我也传了一份&＃xff1a;https://codechina.csdn.net/linxinfa/unity-xcodeapi

原理

其实&＃xff0c;这个工具的工作原理并不复杂&＃xff0c;利用的是Unity工作的一个固定流程&＃xff1a;Unity在导出工程之后&＃xff0c;会去继续搜索并执行被标记为[PostProcessBuildAttribute]的方法&＃xff0c;而对于Unity导出的iOS工程&＃xff0c;所有的配置信息都会被记录在一个固定名称的文件里面&＃xff0c;其中一个是导出工程目录下的 Unity-iPhone.xcodeproj/project.pbxproj&＃xff0c;是一个json格式的文本文件&＃xff0c;所有的Build Setting项都在这个文件里面&＃xff1b;另外一个叫Info.plist&＃xff0c;是个xml格式的文件。所以&＃xff0c;这个工具就是提供了json和xml文件操作的能力&＃xff0c;和几个特定的接口&＃xff0c;用于更改指定配置项的内容。

使用

明确这一点之后&＃xff0c;使用起来应该就可以更有数了。使用方法很简单&＃xff0c;只要把工程文件下载下来&＃xff0c;把里面的xcode目录放到你工程的某个Editor目录下&＃xff0c;然后在里面添加一个标记为PostProcessBuildAttribute的方法&＃xff0c;在这个方法里面修改你的xcode工程配置就可以了&＃xff0c;例如下面的类&＃xff0c;也放在Editor目录下&＃xff0c;类名随便取&＃xff1a;

using UnityEditor;
using UnityEditor.Callbacks;
using UnityEditor.iOS.Xcode.Custom;public class ProjectPostProcess
{[PostProcessBuildAttribute(1)]public static void OnPostProcessBuild(BuildTarget buildTarget, string pathToBuiltProject){// 只处理IOS工程&＃xff0c; pathToBuildProject会传入导出的ios工程的根目录if (buildTarget !&＃61; BuildTarget.iOS)return;// 创建工程设置对象var projectPath &＃61; pathToBuiltProject &＃43; "/Unity-iPhone.xcodeproj/project.pbxproj";PBXProject project &＃61; new PBXProject();project.ReadFromFile(projectPath);string targetGuid &＃61; project.TargetGuidByName("Unity-iPhone");// 修改BITCODE设置的例子project.SetBuildProperty(targetGuid, "ENABLE_BITCODE", "NO");// 你可能会设置的--------------------------------------------------//project.SetBuildProperty(targetGuid, "CODE_SIGN_IDENTITY", "p12证书的code_sign");// 把证书设置设置为手动&＃xff0c;即不使用Automatically manage signing//project.SetTargetAttributes("ProvisioningStyle","Manual");//project.SetBuildProperty(targetGuid, "PROVISIONING_PROFILE", "mobileprovison文件的UUID");//project.SetBuildProperty(targetGuid, "PROVISIONING_PROFILE_SPECIFIER", "mobileprovison文件的Name");//project.SetTeamId(targetGuid,"证书的TeamId");//project.SetBuildProperty(targetGuid, "IPHONEOS_DEPLOYMENT_TARGET", "8.0");// 添加framework//project.AddFrameworkToProject(targetGuid, "StoreKit.framework", true);//----------------------------------------------------------------// 修改后的内容写回到配置文件File.WriteAllText(projectPath, project.WriteToString());// 修改Info.plist的示例var plistPath &＃61; Path.Combine(pathToBuiltProject, "Info.plist");var plist &＃61; new PlistDocument();plist.ReadFromFile(plistPath);// 增加字符串类型的设置plist.root.SetString("fieldname", "value");// 修改后的内容写回到文件Info.plistplist.WriteToFile(plistPath);}
}

关于这个方法的属性&＃xff0c;网上的有些例子上写的是PostProcessBuild&＃xff0c;其实只是PostProcessBuildAttribute的简写&＃xff0c;意义是一样的&＃xff0c;不需要纠结。

常用的的Property&＃xff1a;

一步到位

如果想要一步到位&＃xff0c;导出xcode后自动执行Archive和生产ipa&＃xff0c;可以写好shell脚本自动运行

Archive脚本

xcodebuild -project "工程目录/Unity-iPhone.xcodeproj" -scheme Unity-iPhone archive -archivePath "Archive的目录"

生成ipa脚本

xcodebuild -project "工程目录/Unity-iPhone.xcodeproj" -exportArchive -exportFormat ipa -archivePath "Archive的目录" -exportPath "ipa的目录" -exportProvisioningProfile "mobileprovision文件的Name"

Xcode7之后取消了原来的-exportFormat&＃xff0c;而是使用exportOptionsPlist 来取代

改用下面的命令

xcodebuild -exportArchive -exportOptionsPlist xxx/Info.plist -archivePath xxx.xcarchive -exportPath ~/Desktop/

例

xcodebuild -exportArchive -exportOptionsPlist ../ExportOptions.plist -archivePath ../testPacking.xcarchive -exportPath ./autoPackage -allowProvisioningUpdates

我们需要自己创建一个plist作为Export Options

写个工具类方便生成

using UnityEngine;
using UnityEditor;
using System.Collections.Generic;class XcodeExportPlist
{///

用上面的XcodeExportPlist工具类生成exportOption.plist

public static string GenArchiveOptPlist()
{var path &＃61; Application.dataPath.Replace("Assets", "Bin/exportOption.plist";var teamId &＃61; "BQCHO456";// "app-store","enterprise","ad-hoc","development"var archiveMethod &＃61; "enterprise";var bundleId &＃61; "com.linxinfa.test";var provisionName &＃61; "linxinfaEnt2019614";XcodeExportPlist.GenFile(path, teamId, archiveMethod, bundleId, provisionName);return path;
}


ExportOptionsPlist文件

结合《Unity中C#如何执行cmd命令&＃xff08;System.Diagnostics.Process的使用&＃xff09;》

https://blog.csdn.net/linxinfa/article/details/52982384

可以通过C#执行shell命令

//var version &＃61; "1.0.0";
//var binPath &＃61; Application.dataPath &＃43; "/../Bin";
//var xcodeProjPath &＃61; binPath &＃43; "/XcodeProj";
//var xcodeArchPath &＃61; binPath &＃43; "/Archives/Unity-iPhone-archive.xcarchive";
//var outputPath &＃61; string.Format("{0}/{1}/", binPath, version);
//var appName &＃61; string.Format("mygame_v{0}_{1}.ipa", version, DateTime.Now.ToString("yyyyMMdd"));private static void XCodeArchive(string xcodeProjPath, string xcodeArchPath)
{Debug.Log("XCodeArchive Begin");string args &＃61; string.Format("-project \"{0}/Unity-iPhone.xcodeproj\" -scheme Unity-iPhone archive -archivePath \"{1}\" ", xcodeProjPath, xcodeArchPath);var r &＃61; EdtUtil.RunCmd("xcodebuild", args);if (string.IsNullOrEmpty(r[0]) || r[0].LastIndexOf("ARCHIVE SUCCEEDED") <0){Debug.LogError("Build IPA : XCodeBuildArchive FAILED\n" &＃43; r[0]);throw new Exception("Build IPA : XCodeBuildArchive FAILED");}Debug.LogGreen("Build IPA : XCodeBuildArchive OK");
}private static void XCodeExportIPA(string xcodeProjPath, string xcodeArchPath, string outputPath, string ipaName)
{// 生成plistvar expOptPath &＃61; GenArchiveOptPlist();Debug.Log("XCodeExportIPA Begin\n xcodeProjPath: " &＃43; xcodeProjPath &＃43; "\nxcodeArchPath: " &＃43; xcodeArchPath &＃43; "\noutputPath: " &＃43; outputPath);string args &＃61; string.Format("-project \"{0}/Unity-iPhone.xcodeproj\" -exportArchive -archivePath \"{1}\" -exportPath \"{2}\" -exportOptionsPlist \"{3}\" ",xcodeProjPath, xcodeArchPath, outputPath, expOptPath);var r &＃61; EdtUtil.RunCmd("xcodebuild", args);if (string.IsNullOrEmpty(r[0]) || r[0].LastIndexOf("EXPORT SUCCEEDED") <0){Debug.LogError("Build IPA : XCodeBuildIPA FAILED\n" &＃43; r[0]);throw new Exception("Build IPA : XCodeBuildIPA FAILED");}Debug.LogGreen("Build IPA : XCodeBuild IPA OK");// 重命名File.Move(outputPath &＃43; "Unity-iPhone.ipa", outputPath &＃43; ipaName);
}

如果不放心&＃xff0c;也可以到XCode进行手动ipa打包

Archive&＃xff1a;

先检查Product->Scheme->Edit Scheme...中的设置是否正确&＃xff0c;比如现在是要打的是面向外部玩家的版本&＃xff0c;则要Run里面要选择Relaese&＃xff0c;Archive里也要选择Release&＃xff0c;记得勾选Archive的Options的Reveal Archive in Organizer&＃xff0c;检查工程的General中的证书设置是否正确&＃xff0c;检查工程的Images.xcassets中的AppIcon的图标设置是否正常

检查无误之后&＃xff0c;就可以执行Archive了: Product->Archive

导出ipa&＃xff1a;

Archive完之后&＃xff0c;会自动弹出Organizer窗口&＃xff0c;如果没有弹出来&＃xff0c;则手动打开&＃xff1a;Window->Organizer

然后点击Distribute App按钮&＃xff0c;接下来一步一步Next&＃xff0c;注意中间会让你选择一些选项&＃xff0c;根据需求进行选择即可

补充&＃xff1a;

如果要对不同的配置做修改&＃xff0c;比如&＃xff0c;单独修改Debug版本或者Release版本的配置项&＃xff0c;那么就需要用BuildConfigByName先获取到指定的配置项&＃xff0c;然后使用SetBuildPropertyForConfig设置对应的配置项&＃xff0c;例如&＃xff0c;单独修改debug版本的ENABLE_BITCODE设置&＃xff1a;

string configGuid &＃61; project.BuildConfigByName("targetGuid", "Debug");
project.SetBuildPropertyForConfig(configGuid, "ENABLE_BITCODE", "NO");

另外&＃xff0c;对于XUPorter的导出插件和native代码的功能&＃xff0c;Unity 5之后可以直接把需要的文件放在Assets/Plugins/iOS目录下面&＃xff0c;文件就会被自动导出到目标工程中&＃xff0c;请参考Unity文档&＃xff1a;https://docs.unity3d.com/Manual/PluginsForIOS.html
 

参考&＃xff1a;https://blog.csdn.net/yubo112002/article/details/83449694