Skip to content

integrateShareTrace

集成ShareTrace分享到Android项目,自动配置相关文件和依赖。

前置依赖

依赖参数

参数名类型说明
deps.existsSyncFileSystem['existsSync']检查文件是否存在
deps.readFileSyncFileSystem['readFileSync']读取文件内容
deps.writeFileSyncFileSystem['writeFileSync']写入文件内容
deps.copyFileSyncFileSystem['copyFileSync']复制文件
deps.joinPath['join']路径拼接
deps.xmlParserXMLParserConstructorXML 解析器构造函数
deps.xmlSerializerXMLSerializerConstructorXML 序列化器构造函数
deps.xpathXPathXPath 查询库

环境要求

  • @xmldom/xmldom: XML DOM 解析库
  • xpath: XPath 查询库
bash
npm install @xmldom/xmldom xpath

函数签名

typescript
function integrateShareTrace(
  projectPath: string,
  moduleDir: string,
  packageName: string,
  config: ShareTraceConfig,
  deps: IntegrateThirdPartyModuleDeps
): Promise<{ success: boolean; message?: string; error?: string; logs: string[] }>

interface ShareTraceConfig {
  appKey: string  // ShareTrace AppKey(从ShareTrace控制台获取)
}

参数

参数名类型必填说明
projectPathstringAndroid项目路径
moduleDirstring模块目录(如 'app' 或 'HBuilder-uniPlugin')
packageNamestring应用包名
config.appKeystringShareTrace AppKey
depsIntegrateThirdPartyModuleDeps依赖注入对象

返回值

类型说明
Promise<{ success: boolean; message?: string; error?: string; logs: string[] }>Promise,解析为集成结果对象

工作原理

  1. 确保Maven仓库:在项目根目录的build.gradle中确保有mavenCentral仓库
  2. 添加Gradle依赖:添加ShareTrace SDK依赖
  3. 配置AndroidManifest.xml:添加ShareTrace AppKey配置
  4. 配置dcloud_properties.xml:添加ShareTrace功能配置

基于 integrateThirdPartyModule 实现,自动处理依赖添加和配置文件修改,确保ShareTrace分享功能正确集成。