如何在 Xamarin 中快速集成 Android 版远程配置
Xamarin作为微软提供的移动服务多系统开发平台,成为很多开发者首选的应用开发平台。AppGallery Connect(以下简称AGC)也在逐步的支持Xamarin的SDK。今天就手把手教大家如何快速接入Xamarin版远程配置服务。
接入步骤
安装Xamarin环境
Xamarin的御用开发平台是Visual Studio,所以我们需要首先安装Visual Studio 2019.
下载地址:https://visualstudio.microsoft.com/zh-hans/downloads/
下载好后进行安装,我们还需要安装Xamarin配套的插件,Mobile development with .NET,中文叫“使用.NET的移动开发”,安装完成后就可以通过Visual Studio进行Xamarin的Android和iOS开发了。
![cke_13819.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.62001160265448560308108120698017:50530418031037:2800:4B363FAC4A5D0DC371526A2FB90123E032F0DA0955A337109A8D9AD75370CD38.png)
在AGC页面开通远程配置并创建相应的配置项
具体配置步骤可以参考远程配置官方文档:
创建Xamarin工程
1、在Visual Studio中创建新项目
选择移动应用(Xamarin.Forms),将应用的名称等信息设置好后,创建项目
![cke_13820.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.41236982574962743883162584826246:50530418031037:2800:D41A5FA0DDBC784E8B269E8AAD23C37BD0276A76AC0D61CFACB8339C407410BA.png)
2、将远程配置的Xamarin包集成到新的项目中
有两种方式集成Xamarin包
第一种是云端方式集成,在目录栏右击选择管理NuGet程序包
![cke_13821.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.74625465740057804200370882187030:50530418031037:2800:0D07EF86670C70AB2FAE7E1642BA44638A4A315D163F05B62DB80B3B75D09A52.png)
在浏览选项中搜索Huawei.Agconnect.RemoteConfiguration,点击安装即可
![cke_13822.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.50765369609555701449513651599184:50530418031037:2800:922FB70445900E36CBE61DFA7EF0FFA8D34A87B803B668A6A22B635A62331D7C.png)
第二种方式是本地集成NuGet包,首先需要将所有需要的NuGet包放入本地的一个文件夹中
![cke_13823.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.97550906193085003558208436288657:50530418031037:2800:8131DC45A1095C4BEF3810F6B439B63AF9FD97F7E7ABAFAE32F25332CA02D048.png)
我们按照第一种的方式打开NuGet包管理器,点击程序包源边上的设置图标,打开选项目录
![cke_13824.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.02226671569416093956649528131252:50530418031037:2800:9CC96B9C19B4ED60871C19B0B75612C341494DE0F4EC046A0AE93DC3BD9EAD68.png)
点击绿色的加号添加新的包源,在源的地方输入刚刚存放NuGet本地包的文件夹目录即可。
![cke_13825.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.64399581107511821084760909868935:50530418031037:2800:86652E1F7C24238BA7F8DAABC61A65618E5B48EC1D371CFBFCBC05E92C35C048.png)
3、添加 AGC 配置文件
AGC为开发者准备了一个存放所有应用相关信息的配置json文件,我们需要将这个文件集成到项目中以便后续调用接口时使用,我们的SDK会自动读取里面的内容,无需开发者调用时手动传入了,具体步骤如下
3.1 从AGC管理台中下载agconnect-services.json文件,将文件放入项目的Assets目录下
![cke_13826.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.69150927665909385726742773915272:50530418031037:2800:5AE2756429DA2917237EA8548DCF253BD1C89B0037FCFF6F6EE69AED4F3105A3.png)
3.2 在项目中创建一个新的类,HmsLazyInputStreams.cs,将如下代码写入进行json文件的内容读取
using System;
using System.IO;
using Android.Util;
using Android.Content;
using Huawei.Agconnect.Config;
namespace XamarinHmsRemoteConfig
{
class HmsLazyInputStream : LazyInputStream
{
public HmsLazyInputStream(Context context) : base(context)
{
Get(context);
}
public override Stream Get(Context context)
{
try
{
return context.Assets.Open("agconnect-services.json");
}
catch (Exception e)
{
Log.Error(e.ToString(), "Can't open agconnect file");
return null;
}
}
}
}
3.3 再创建一个Content provider类,写入如下代码已让读取文件可以在启动应用时进行,要注意,content provider中的包名需要与应用包名一致(包括项目中设置的包名以及在AGC管理台中设置的包名)。
using System;
using Android.Content;
using Android.Database;
using Huawei.Agconnect.Config;
namespace XamarinHmsRemoteConfig
{
[ContentProvider(new string[] { "com.huawei.cordova.remoteconfig.XamarinCustomProvider" }, InitOrder = 99)]
public class XamarinCustomProvider : ContentProvider
{
public override int Delete(Android.Net.Uri uri, string selection, string[] selectionArgs)
{
throw new NotImplementedException();
}
public override string GetType(Android.Net.Uri uri)
{
throw new NotImplementedException();
}
public override Android.Net.Uri Insert(Android.Net.Uri uri, ContentValues values)
{
throw new NotImplementedException();
}
public override bool OnCreate()
{
AGConnectServicesConfig config = AGConnectServicesConfig.FromContext(Context);
config.OverlayWith(new HmsLazyInputStream(Context));
return false;
}
public override ICursor Query(Android.Net.Uri uri, string[] projection, string selection, string[] selectionArgs, string sortOrder)
{
throw new NotImplementedException();
}
public override int Update(Android.Net.Uri uri, ContentValues values, string selection, string[] selectionArgs)
{
throw new NotImplementedException();
}
}
}
3.4 设置包名
右击项目找到属性选项,在Android清单页签找到程序包名称,设置应用的包名。
![cke_13827.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.92374078051370323800056578246981:50530418031037:2800:3E239FF5D4FC966666D1009D2CB002DBDD375BD8F3A295A3F34AC6FB59ED9B41.png)
4、添加本地默认配置
远程配置支持开发者在本地配置一个默认值。这种配置有两种方式,
第一种是通过xml文件设置相关配置,我们可以在Resource文件夹下的Xml文件夹创建一个xml文件,存放配置项和默认值
![cke_13828.png](https://alliance-communityfile-drcn.dbankcdn.com/FileServer/getFile/cmtybbs/150/224/722/0900086000150224722.20210702192611.41757745988050401224138695319628:50530418031037:2800:C626795CFCC61F02135F31C227ACA661635827C96F1E48C548D038111B4F4187.png)
在代码中调用ApplyDefault方法读取相应的xml文件即可
AGConnectConfig.Instance.ApplyDefault(Resource.Xml.RemoteConfig);
第二种方式实在代码中动态的设置默认配置,示例如下:
IDictionary<string, Java.Lang.Object> ConfigVariables = new Dictionary<string, Java.Lang.Object>();
ConfigVariables.Add("value1", "Default");
AGConnectConfig.Instance.ApplyDefault(ConfigVariables);
5、Fetch
Fetch功能是远程配置最核心的功能,fetch接口可以从云端将最新的配置值下载到本地来进行实时配置。接口有一个参数,代表着接口从云端获取值的间隔,如果不传值,那么我们就会默认为12小时。
AGConnectConfig.Instance.Fetch(fetchInterval).AddOnSuccessListener(new TaskListener(this)).AddOnFailureListener(new TaskListener(this));
6、MergedAll
其余的接口都与Android版本一致,但是有一个接口与Android版本名称上有些许不同,就是MergedAll方法。这个方法在Android上名称为getMergedAll,作用是返回默认值和云端值合并后的所有值。
AGConnectConfig.Instance.MergedAll;
以上就是快速接入Xamarin版远程配置的全部流程,随着越来越多的服务支持Xamarin,我也会给大家带来更多的接入教程。