MAUI + Masa Blazor 開發帶自動更新功能的安卓App

語言: CN / TW / HK

自動更新主要下面4個步驟

  1. 獲取最新版本號
  2. 提示用户發現更新,等待用户確認更新
  3. 下載最新的apk包
  4. 安裝apk包

下面從創建MAUI項目開始

1、創建Maui Blazor Server應用

Alt

2、安裝Masa.Blazor,並添加引用

dotnet add package Masa.Blazor

wwwroot/index.html 中引入資源文件

<!-- masa blazor css style -->
	<link href="http://masa-blazor-docs-dev.lonsid.cn/_content/Masa.Blazor/css/masa-blazor.min.css" rel="stylesheet">
    <link href="http://cdn.masastack.com/npm/@mdi/[email protected]/css/materialdesignicons.min.css" rel="stylesheet">
	<link href="http://cdn.masastack.com/npm/materialicons/materialicons.css" rel="stylesheet">
	<link href="http://cdn.masastack.com/npm/fontawesome/v5.0.13/css/all.css" rel="stylesheet">
    <link rel="stylesheet" href="http://cdn.masastack.com/stack/fonts/roboto/font-roboto.css">

<!--js(should lay the end of file)-->
    <script src="_content/BlazorComponent/js/blazor-component.js"></script>

_Imports.razor 添加,對Masa Blazor 的全局引用

@using Masa.Blazor
@using BlazorComponent

MauiProgram.cs中注入服務

builder.Services.AddMasaBlazor();

修改Shared / MainLayout.razor文件,設置MApp為根元素

@inherits LayoutComponentBase

<div class="page">
	<div class="sidebar">
		<NavMenu />
	</div>
	<main>
		<div class="top-row px-4">
			<a href="http://docs.microsoft.com/aspnet/" target="_blank">About</a>
		</div>
		<article class="content px-4">
            <MApp>@Body</MApp>
		</article>
	</main>
</div>

項目屬性中修改-已共享MAUI-中的應用程序ID及版本 Alt

3、開始編寫代碼

創建Service目錄,添加IUpgradeService.cs接口

namespace MauiMasaBlazorDemo.Service
{
    public interface IUpgradeService
    {
        /// <summary>
        /// 檢查更新
        /// </summary>
        /// <param name="url">
        /// 檢查URL
        /// </param>
        /// <returns></returns>
        Task<Dictionary<string, string>> CheckUpdatesAsync(string url);

        /// <summary>
        /// 下載安裝文件
        /// </summary>
        /// <param name="url">
        /// 下載URL
        /// </param>
        /// <param name="action">
        /// 進度條處理方法
        /// </param>
        /// <returns></returns>
        Task DownloadFileAsync(string url, Action<long, long> action);

        /// <summary>
        /// 安裝APK的方法
        /// </summary>
        void InstallNewVersion();
    }
}

​ 這裏需要使用到 FileProvider,在Android 7之後出於安全考慮不再支持content://URL 或file:///URL這種文件訪問方式,可參考FileProvider | Android Developers ,我們先添加一下對應配置

Platforms/Android/Resources下面新建xml文件夾,並添加provider_paths.xml文件

<?xml version="1.0" encoding="utf-8"?>
<resources>
	<paths>
		<root-path name="root" path="" />
		<files-path name="files" path="" />
		<cache-path name="cache" path="" />
		<external-path name="camera_photos" path="" />
		<external-files-path name="external_file_path" path="" />
		<external-cache-path name="external_cache_path" path="" />
	</paths>
</resources>

修改Platforms / Android下面的AndroidManifest.xml文件,在application下添加provider,再添加一個安卓安裝的權限REQUEST_INSTALL_PACKAGES

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
	<application android:allowBackup="true" android:icon="@mipmap/appicon" android:roundIcon="@mipmap/appicon_round" android:supportsRtl="true">
		<provider
			android:name="androidx.core.content.FileProvider"
			android:authorities="com.masa.mauidemo.fileprovider"
			android:exported="false"
			android:grantUriPermissions="true">
			<meta-data
				android:name="android.support.FILE_PROVIDER_PATHS"
				android:resource="@xml/provider_paths" />
		</provider>
	</application>
	<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
	<uses-permission android:name="android.permission.INTERNET" />
	<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
</manifest>

​ 在Platforms / Android下添加UpgradeService.cs

獲取版本號可以通過MAUI提供的 VersionTracking,該類還有很多版本相關的功能,可參考

Version tracking - .NET MAUI | Microsoft Docs

Intent 是一種運行時綁定(run-time binding)機制,Android的三個基本組件 Activity,Service和Broadcast Receiver 都是通過Intent機制激活的,有興趣可參考 Intent | Android Developers

using Android.Content;
using Android.OS;
using MauiMasaBlazorDemo.Service;

namespace MauiMasaBlazorDemo
{
    public class UpgradeService : IUpgradeService
    {
        readonly HttpClient _client;
        public UpgradeService()
        {
            _client = new HttpClient();
        }
        public async Task<Dictionary<string, string>> CheckUpdatesAsync(string url)
        {
            var result = new Dictionary<string, string>();
            // 獲取當前版本號
            var currentVersion = VersionTracking.CurrentVersion;
            var latestVersion = await _client.GetStringAsync(url);
            result.Add("CurrentVersion", currentVersion);
            result.Add("LatestVersion", latestVersion);
            return result;
        }

        public void InstallNewVersion()
        {
            var file = $"{FileSystem.AppDataDirectory}/{"com.masa.mauidemo.apk"}";

            var apkFile = new Java.IO.File(file);

            var intent = new Intent(Intent.ActionView);
            // 判斷Android版本
            if (Build.VERSION.SdkInt >= BuildVersionCodes.N)
            {
                //給臨時讀取權限
                intent.SetFlags(ActivityFlags.GrantReadUriPermission);
                var uri = FileProvider.GetUriForFile(Android.App.Application.Context, "com.masa.mauidemo.fileprovider", apkFile);
                // 設置顯式 MIME 數據類型
                intent.SetDataAndType(uri, "application/vnd.android.package-archive");
            }
            else
            {
                intent.SetDataAndType(Android.Net.Uri.FromFile(new Java.IO.File(file)), "application/vnd.android.package-archive");
            }
            //指定以新任務的方式啟動Activity
            intent.AddFlags(ActivityFlags.NewTask);
            
            //激活一個新的Activity
            Android.App.Application.Context.StartActivity(intent);
        }

        public async Task DownloadFileAsync(string url, Action<long, long> action)
        {
            var req = new HttpRequestMessage(new HttpMethod("GET"), url);
            var response = _client.SendAsync(req, HttpCompletionOption.ResponseHeadersRead).Result;
            var allLength = response.Content.Headers.ContentLength;
            var stream = await response.Content.ReadAsStreamAsync();
            var file = $"{FileSystem.AppDataDirectory}/{"com.masa.mauidemo.apk"}";
            await using var fileStream = new FileStream(file, FileMode.Create);
            await using (stream)
            {
                var buffer = new byte[10240];
                var readLength = 0;
                int length;
                while ((length = await stream.ReadAsync(buffer, 0, buffer.Length)) != 0)
                {
                    readLength += length;
                    action(readLength, allLength!.Value);
                    // 寫入到文件
                    fileStream.Write(buffer, 0, length);
                }
            }
        }
    }
}

其中com.masa.mauidemo.apk 為安裝文件apk的文件名稱。

MauiProgram.cs中添加註入,這裏使用條件編譯,在平台為Android時使用

#if ANDROID
            builder.Services.AddSingleton<IUpgradeService, UpgradeService>();
#endif

Pages中新增Index.razor.cs

using BlazorComponent;
using Masa.Blazor;
using MauiMasaBlazorDemo.Service;
using Microsoft.AspNetCore.Components;

namespace MauiMasaBlazorDemo.Pages
{
    public partial class Index
    {
        [Inject]
        public IPopupService PopupService { get; set; }

        [Inject]
        private IUpgradeService UpgradeService { get; set; }
        private int Ps { get; set; }

        private long TotalBytesToReceive { get; set; }

        private long BytesReceived { get; set; }

        private long _unReadMsgCnt = 0;

        private bool _updateDialog;
        /// <summary>
        /// 獲取最新版本
        /// </summary>
        /// <returns></returns>
        public async Task GetVersionNew()
        {
            var result = await UpgradeService.CheckUpdatesAsync($"http://你的域名/update.txt?t={DateTime.Now.ToUniversalTime().Ticks}");
            if (result["CurrentVersion"] != result["LatestVersion"])
            {
                var confirm = await PopupService.ConfirmAsync($"檢測到新版本,是否升級", "版本號為:" + result["LatestVersion"]);
                if (confirm)
                {
                    _updateDialog = true;
                    await UpgradeService.DownloadFileAsync("http://你的域名/com.masa.mauidemo.apk", DownloadProgressChanged);
                    UpgradeService.InstallNewVersion();
                }
            }
            else
            {
                await PopupService.AlertAsync($"當前版本已經是最新版,版本號為:" + result["LatestVersion"], AlertTypes.Success);
            }
        }

        private void DownloadProgressChanged(long readLength, long allLength)
        {
            InvokeAsync(() =>
            {
                var c = (int)(readLength * 100 / allLength);

                if (c > 0 && c % 5 == 0) //刷新進度為每5%更新一次,過快的刷新會導致頁面顯示數值與實際不一致
                {
                    Ps = c; //下載完成百分比
                    BytesReceived = readLength / 1024; //當前已經下載的Kb
                    TotalBytesToReceive = allLength / 1024; //文件總大小Kb
                    StateHasChanged();
                }
            });
        }
    }
}

修改Index.razor 添加按鈕、確認對話框、進度條組件。Masa blazor是國內不多可以完美支持MAUI的blazor組件

@page "/"
<MButton OnClick="GetVersionNew">
    <MLabel>檢查更新</MLabel>
    <MIcon>mdi-home</MIcon>
</MButton>
<div class="text-center">
    <MDialog @bind-Value="_updateDialog"
             Width="500">
        <ChildContent>
            <MCard>
                <MCardTitle Class="text-h5 grey lighten-2">
                    正在更新請稍後...
                </MCardTitle>
                <MCardText>
                    @BytesReceived KB/@TotalBytesToReceive KB
                    <MProgressLinear Value="@Ps" Striped Height="15" Color="light-blue">
                        <strong>@Ps %</strong>
                    </MProgressLinear>
                </MCardText>
            </MCard>
        </ChildContent>
    </MDialog>
</div>

4、項目打包、簽名、發佈

項目屬性中修改Android包格式為Apk Alt 命令行生成一個安卓簽名證書(部分手機沒有證書籤名不允許安裝),過程中會提示輸入證書密碼,密碼要記住,其他隨意填

keytool -genkey -v -keystore masa-maui-demo.keystore -alias key -keyalg RSA -keysize 2048 -validity 10000

Alt 項目屬性,切換到-Android-包簽名,勾選“APK簽名”密鑰存儲選擇剛剛生成的keystore文件,輸入密鑰“存儲密碼”和“別名密碼”,這兩個密碼都填剛剛生成證書的密碼,別名不設置的情況下,也需要輸入別名密碼,否則會在發佈時提示“打包進程失敗”。 Alt 解決方案配置中切換到Release,生成一下項目,然後右鍵項目名稱-選擇發佈,發佈0.0.1版本,發佈過程會自動對apk進行簽名 Alt 點右下角的打開文件夾,找到簽名之後的apk文件,上傳到阿里雲OSS,同時再上傳一個名為update.txt的文本文件,內容為“0.0.1”,這兩個文件的地址就是GetVersionNew方法中的兩個地址。 Alt 注意:

1、如果使用的下載apk的協議不是https,那麼需要在AndroidManifest.xml文件 application 節點中添加 android:usesCleartextTraffic="true"

2、如果是使用iis的話需要在MIEI中添加 MIME類型:

application/vnd.android.package-archive,否則apk文件無法下載

這樣我們的自動升級功能就開發完畢了,如果程序新加了功能我們我們需要做:

1、修改項目的版本號,例如修改“應用程序顯示版本”為0.0.2,應用程序版本:2

2、重新發布apk

3、上傳到阿里雲OSS,修改update.txt文件為0.0.2

下面為真機演示效果

Alt