如何在Corda中为CorDapp提供自定义配置？含外部交互最佳实践咨询

嘿，刚好我之前做过CorDapp和外部系统交互的场景，关于配置这块踩过一些坑，给你梳理下具体的实现方法和最佳实践，应该能帮到你！

Corda支持你用.properties或.yaml文件来存自定义配置，也可以直接用节点的node.conf来配置，两种方式各有优劣，看你的需求选：

1.1 用独立的.properties/.yaml文件 #

这种方式适合需要频繁修改配置、不想动node.conf的场景：

• 存放位置：把配置文件放在节点的cordapps/config目录下，建议给每个CorDapp单独命名（比如my-trade-corapp-config.properties），避免和其他CorDapp的配置冲突。
• 加载.properties示例：

  import java.io.FileInputStream
  import java.util.Properties
  import net.corda.core.flows.FlowLogic
  import net.corda.core.flows.InitiatingFlow
  import net.corda.core.flows.StartableByRPC
  
  @InitiatingFlow
  @StartableByRPC
  class ExternalApiFlow : FlowLogic<String>() {
      override fun call(): String {
          // 获取节点配置目录路径
          val configDir = serviceHub.nodeConfiguration.configDirectory
          // 拼接配置文件路径
          val propsPath = configDir.resolve("cordapps").resolve("my-trade-corapp-config.properties")
          
          val props = Properties()
          // 加载配置文件
          FileInputStream(propsPath.toFile()).use { props.load(it) }
          
          // 读取配置参数
          val apiUsername = props.getProperty("external.api.username")
          val apiPassword = props.getProperty("external.api.password")
          
          // 这里写调用外部API的逻辑
          return "调用外部API成功，用户名：$apiUsername"
      }
  }
  

• 加载.yaml示例：
  先定义一个数据类映射配置结构，再用SnakeYAML加载：

  import org.yaml.snakeyaml.Yaml
  import java.io.FileInputStream
  import net.corda.core.flows.FlowLogic
  import net.corda.core.flows.InitiatingFlow
  import net.corda.core.flows.StartableByRPC
  
  // 映射yaml结构的数据类
  data class ApiConfig(
      val external: ExternalApiSettings
  )
  
  data class ExternalApiSettings(
      val api: ApiCredentials
  )
  
  data class ApiCredentials(
      val username: String,
      val password: String
  )
  
  @InitiatingFlow
  @StartableByRPC
  class YamlConfigFlow : FlowLogic<String>() {
      override fun call(): String {
          val configDir = serviceHub.nodeConfiguration.configDirectory
          val yamlPath = configDir.resolve("cordapps").resolve("my-trade-corapp-config.yaml")
          
          val yaml = Yaml()
          val config = yaml.loadAs(FileInputStream(yamlPath.toFile()), ApiConfig::class.java)
          
          val apiUsername = config.external.api.username
          val apiPassword = config.external.api.password
          
          return "通过YAML配置调用API，用户名：$apiUsername"
      }
  }
  

  对应的yaml文件内容：

  external:
    api:
      username: "trade_user"
      password: "trade_secure_pass"
  

1.2 用Corda原生的node.conf配置 #

如果不想维护单独的配置文件，Corda允许在node.conf里给每个CorDapp单独配置参数，这种方式更贴合Corda的生态：

• 在node.conf中添加配置：

  corDappConfigs {
      # 这里填你的CorDapp主包名
      com.example.mytradecorapp {
          external {
              api {
                  username = "prod_trade_user"
                  password = "prod_secure_pass"
              }
          }
      }
  }
  

• 在Flow中获取配置：

  import net.corda.core.flows.FlowLogic
  import net.corda.core.flows.InitiatingFlow
  import net.corda.core.flows.StartableByRPC
  
  @InitiatingFlow
  @StartableByRPC
  class NodeConfigFlow : FlowLogic<String>() {
      override fun call(): String {
          // 获取当前CorDapp的专属配置
          val corappConfig = serviceHub.appContext.config
          // 逐层读取配置
          val apiUsername = corappConfig.getConfig("external").getConfig("api").getString("username")
          val apiPassword = corappConfig.getConfig("external").getConfig("api").getString("password")
          
          return "通过node.conf配置调用API，用户名：$apiUsername"
      }
  }
  

这些点一定要注意，不然容易踩坑：

• 敏感信息必须加密：绝对不要明文存密码、密钥这类敏感数据！可以用Corda的加密工具把敏感信息加密后存在配置里，在Flow中用节点的私钥解密；或者直接用节点的KeyStore来存储，通过serviceHub.keyStoreService获取。
• 配置隔离：每个CorDapp用独立的配置文件/节点配置块，避免参数冲突，比如命名前缀加上CorDapp的业务名称。
• 避免硬编码：所有外部依赖的参数都要从配置加载，方便切换开发、测试、生产环境。
• 配置校验：加载配置后一定要做参数校验，比如检查用户名、密码是否为空，避免调用外部API时因为配置缺失报错。
• 优先用node.conf：如果不是特别需要独立配置文件，尽量用Corda原生的corDappConfigs，它支持配置优先级、加密等Corda内置功能，维护起来更省心。

内容的提问来源于stack exchange，提问作者Alexey