文档 / 组件交付

如何使用组件云参数配置服务

组件访问参数:

组件服务,在设计上为了能够适应多种集成使用场景,可以通过开发服务参数的方式提供给集成者使用(如:主题、标题、股票代码、广告开关等),组件服务参数遵守URL规范与组件服务地址一同使用。

访问参数的字段说明:

组件访问参数的使用

comp_param_step0

组件开发者者需要在开发组件时通过开发框架获取组件访问的url参数,
根据需要在代码中实现参数所控制的功能,最终实现组件访问参数的使用。
eg:http://demo.lightyy.com/index.html?theme=2

不带参数theme访问组件的实例,组件显示主题为默认的蓝色背景主题,如果按照上述eg的方式带theme=2访问组件实例,组件的显示主题会改为红色背景主题,这样可以让组件做到个性化展示。

组件运行配置:

组件服务,在实现多集成场景适应时,有些数据不适合在调用时参数传递,更适合做为后台的一些控制配置项来使用(如,广告链接及广告图片地址等),这些配置项可以结合访问参数配合使用,也可以单独使用,相同组件的不同服务实例的配置项是独立失效的互不干扰;

组件的运行配置是用来规范实例的运行配置的。组件开发者可以通过组件管理台的参数配置项管理组件的运行配置。开发者能够对组件运行配置实现增、删、改、查的管理。

配置项的字段说明:

组件的运行配置开始添加设置后只会在组件的测试版本上生效。当组件运行配置完成后发布组件的新版本,发布后的新版本就会获取组件现有的所有运行配置。新版本一旦创建,版本所支持的运行参数就会与组件的运行配置相互独立,互不干扰。

实例的运行配置:

当组件配置了运行配置后发布新版本,再使用新版本创建实例,创建的实例的就会使用新版本所对应的所有运行配置项。实例的创建者只能通过修改已有的实例配置项的配置值对实例进行配置,而无权对已有的配置项进行其它管理。如果实例创建者不修改实例的配置值,则实例配置项的配置值使用默认值。

实例升级到新版本后实例将使用新版本所对应的运行配置项,如果新版本与升级前的旧版本有相同的配置项,同时这些相同的配置项在版本升级之前修改过,那么这些相同的配置项的值将仍旧使用版本升级前的修改值。

运行配置的使用

comp_param_step0

comp_param_step1

<!DOCTYPE html>
<html>
<script src="//cdn.bootcss.com/jquery/2.2.4/jquery.js"></script>
<!--引入组件开发的SDK-->
<script src="http://res.lightyy.com/sdk/light-sdk-0.0.1.js"></script>
</html>
<!DOCTYPE html>
<html>
<script src="//cdn.bootcss.com/jquery/2.2.4/jquery.js"></script>
<!--引入组件开发的SDK-->
<script src="http://res.lightyy.com/sdk/light-sdk-0.0.1.js"></script>
<!--注册SDK-->
<script>
//注册SDK
LightSDK.register({
cid:"xxxxxx" //组件ID
});
//同步获取运行配置参数
//通过配置key同步获取配置值
LightSDK.config.get("layout_param",function (value) {
console.log(value); //value = 1
});
//同步获取全部运行配置项
LightSDK.config.get(function (value) {
console.log(value); // value = {"layout_param" : "1"}
});
//异步获取配置参数
//通过配置key异步获取配置
var value = LightSDK.config.get("layout_param"); //value = 1
//异步获取全部运行配置项
var values = LightSDK.config.get(); // value = {"layout_param" : "1"}
</script>
</html>
......

组件开发过程中,通过上述步骤就可以获取组件的运行配置。在上述例子中我们获取布局参数layout_param的值“1”。我们在组件开发中可以通过此参数控制页面的布局,从而使页面布局显示为列表布局或网格的九宫格布局;

当组件开发完成后,发布版本、创建实例,此时实例获取的参数就是实例的配置参数。我们可以将实例的布局配置值设置为“2”,实现访问实例页面的九宫格的网格布局显示;