Sparkle使用方法（mac软件自动升级开源类库）

2016-03-07 本文已影响1924人袏扌戒指

类库官网：https://sparkle-project.org/

原文：http://www.cocoachina.com/mac/20100920/2111.html

作为一名桌面软件开发者，应该提早考虑程序的更新问题。如何将程序更新及时优雅的推送给用户，是维持用户忠诚度和提高软件使用体验的一个重要方面。而作为Cocoa应用程序开发者，我们可以选择自己手动来实现此功能，也可以选择一些优秀的开源框架。Sparkle就是其中之一。

Sparkle是一个非常简单且易用的Cocoa应用程序更新框架。本篇文章将使用一个简单的例子，教你如何使用Sparkle为你的Cocoa应用程序加入更新支持。

1: 新建一个Cocoa Application，TestSparkle

2: 去到Sparkle下载Sparkle Framework，最新版本为 1.5b6,

Sparkle Test App.app 是一个用来演示Sparkle更新框架的一个应用程序。

Extras文件夹下提供了Sparkle的标准图标，Release Notes模版，软件签名工具，源代码和Appcast.xml示例文件，我们后面会再讲到这些工具和文件。

With Garbage Collection, 是一个加入了Garbage Collection支持的Sparkle分发版，如果你的应用程序运行在有GC的环境下，则可以使用这个版本的Sparkle

Sparkle.framework 是通用分发版，笔者建议大家使用此版本的Sparkle。

3: 链接Sparkle框架到TestSparkle工程

拖拽Sparkle.framework(或 with Garbage Collection下的 Sparkle.framework)到TestSparkle的Linked Frameworks下，在弹出窗口中记得选中”Copy items into destination group’s folder (if needed)”前面的复选框。

4: 为你的工程新建一个Copy Files Build Phase,

5: 右键点击这个新建的Copy Files Build Phase，并在弹出窗口中，点击Destination下拉框，选择Frameworks

6: 从Library中拖拽一个 NSObject到MainMenu主窗口.

7: 点击此Object对象，点击Inspector，设定此Object的Class为 SUUpdater

8: 添加一个菜单项到到TestSparkle Menu，重命名为 Check For Updates…

9: 将 Check for Updates…菜单项的Send Actions指向Updater Object的checkForUpdates方法

10: 保存Interface Builder的所有更改，退出Interface Builder。

11: 为了安全防止应用程序更新遭到恶意篡改，我推荐对应用程序更新添加数字签名。

Sparkle使用DAS SHA-1 来对程序更新包进行数字签名。

打开终端，进入步骤2中存放已下载的Sparkle包的文件夹，进入Extras–>Signing Tools，

执行,

ruby generate_keys.rb

这个命令将会生成两个文件 dsa_priv.pem 和 dsa_pub.pem，也就是私钥和公钥，请妥善保存这两个文件，如果私钥丢失，你得用户将再也无法自动通过已安装的程序来获得更新的更新。

12: 建立一个 App Cast Feed文件

Sparkle的运作机理其实非常简洁，本地应用程序Info.plist中含有一个URL，此URL指向一个在你网站上的App Cast Feed XML文件。当你发布更新的时候，上传新的app到你的网站，更新此app cast xml feed。这样，客户端程序在运行检查更新时，会根据Info Plist中的URL找到并Parse此文件，跟本地软件版本进行比对。如果发现更新，则提示用户。这就是App Cast XML Feed文件的作用。

在步骤14中提到的Extras文件夹下，有一个App Cast XML Feed文件的模版：

http://you.com/app/2.0.html

Wed, 09 Jan 2006 19:20:11 +0000

http://you.com/app/1.5.html

Wed, 01 Jan 2006 12:20:11 +0000

http://you.com/app/1.4.html

Wed, 25 Dec 2005 12:20:11 +0000

我们可以看出，这其实是一个标准的RSS Feed格式的XML文件。我们只要修改相应的项目即可。

下面我们就来一步步的演示如何使用Sparkle为你的程序加入更新支持。

13 打开你的XCode中 TestSparkle 工程，编辑 TestSparkle-Info.plist，加入两个属性，SUPublicDSAKeyFile 和 SUFeedURL

其中，SUFeedURL 将是指向一个 App Cast XML Fee 的 URL，比如我的测试地址是http://10.0.1.2/~buick/testsparkleappcast.xml，SUPublicDSAKeyFile 指向公钥，我们把刚才步骤14中生成的 dsa_pub.pem 加入到工程的Resources中，并在 TestSparkle-Info.plist 中指定此公钥的名称，，，，那么现在的TestSparkle-Info.plist应该是这样

整个配置完成，我们现在来构建一个TestSparkle.app的1.0版本，点击Build and Run

启动TestSparkle.app, 在TestSparkle菜单下，确认Check for Updates…按钮处于可用状态，如果是灰色不可点击，则返回Interface Builder修改。

将此 TestSparkle.app 1.0 版本拷贝到别处备用。然后返回XCode，将应用程序版本改为1.1,然后构建工程。将TestSparkle.app 的1.1版本打包成zip文件，改名为TestSparkle_1.1.zip

将 dsa_priv.pem (私钥) 和 TestSparkle_1.1.zip 拷贝到 Extras下的Signing Tool文件夹中，

打开终端进入到此文件夹，执行：

ruby sign_update.rb TestSparkle_1.1.zip dsa_priv.pem

便可得到升级包的签名，MCwCFDZsrVGB+PewvxioJcvptkqchXi3AhQOZDJ4UukRM2/bYmZzzbHTxM2kpA==

用文本编辑器创建一个xml文件(UTF-8 编码)，内容如下：

http://10.0.1.2/~buick The latest TestSparkle updates from localhost, more hot features and sweeties

Fri, 10 Sept 2010 0:00:00 +0300 http://10.0.1.2/~buick

注意(由于本网站HTML的设置问题，如果你直接拷贝以上XML Feed文件到你本地测试可能会出编码问题导致XML Parse失败，请到本文最后下载此文件，以及工程压缩包)。

把此XML另存为 testsparkleappcast.xml

熟悉RSS Feed的读者可能很容易理解此文件，，如果我们在浏览器中直接访问此URL，我们会看到

而我们要关注的只是这两段:

这段指定的URL是一个介绍页面，如果你希望在更新提示窗口中出现一个介绍新版本的页面(或者说release notes)，则使用此URL定向到你网站上的新版本介绍页面。

Sparkle非常贴心的为大家提供了一个模版，在Extras/Release Notes Templates 文件夹下可找到

enclosure sparkle:version=“1.1” sparkle:shortVersionString="3.0" sparkle:dsaSignature=“MCwCFDZsrVGB+PewvxioJcvptkqchXi3AhQOZDJ4UukRM2/bYmZzzbHTxM2kpA==“ url=“http://10.0.1.2/~buick/TestSparkle_1.1.zip” length=“436264” type=“application/octet-stream”/>

这段是实现Sparkle Update的关键，

sparkle:version=“1.1” 是buile的版本号，在更新的时候以shortVersion为主

sparkle:shortVersionString="3.0" 是指当前更新包版本号，客户端程序就是根据这个版本号来和本地APP进行比对，如果发现不同则提示更新。

sparkle:dsaSignature=“MCwCFDZsrVGB+PewvxioJcvptkqchXi3AhQOZDJ4UukRM2/bYmZzzbHTxM2kpA==“ 这个就是我们刚才为更新包生成的数字签名

url=“http://10.0.1.2/~buick/TestSparkle_1.1.zip” 指向更新包下载地址

length=“436264” 指更新包的大小，上传上去前用终端 ls -al 命令可查看

type=“application/octet-stream” 是一个想对固定的值，一般不用修改。

现在把testsparkleappcast.xml 和 TestSparkle_1.1.zip 拷贝到服务器上

然后在浏览器敲入http://10.0.1.2/~buick/testsparkleappcast.xml

如果能够看到类似网页，，，说明一切正常。

下面找到我们刚才保存的TestSparkle.app 1.0版本，运行并点击 Check for Updates… 如果一切正常，你可以看到