ZConfig手册

ZConfig手册

一个基于Spring.Net AOP，实现的一个关于应用程序配置文件的加载和回写的解决方案。通过简单的设置，可以再特定的方法调用前加载配置，方法调用后保存参数。

项目地址：https://gitcafe.com/atskyline/ZConfig

使用方法

1. 你需要一个基本的配置对象,例如如下 ProgramConfig.cs

   using System;
   
   namespace Sample.Config
   {
       public class ProgramConfig
       {
           public String ProgramPath { get; set; }
       }
   }

2.你需要一个继承于ZConfig.IUseConfig的接口，并在接口中声明配置对象的属性，实现这个接口的所有类将支持由ZConfig自动加载和回写接口中的所有属性（通过反射实现）。例如IUseProgramConfig.cs

using ZConfig;
namespace Sample.Config
{
    public interface IUseProgramConfig : IUseConfig
    {
        ProgramConfig ProgramConfig { get; set; }
    }
}

3.在你程序中需要配置对象的类中实现自定义的ZConfig.IUseConfig的子接口，并且在有修改配置对象的方法上标记上ModifyConfig特性，例如Program.cs

using System;
using Sample.Config;
using Spring.Context.Support;
using ZConfig.Attribute;

namespace Sample
{
    public interface IProgram
    {
        void UpdatePath();
        void PrintPath();
    }
    public class Program : IUseProgramConfig, IProgram
    {
        public ProgramConfig ProgramConfig { get; set; }

        [ModifyConfig]
        public virtual void UpdatePath()
        {
            ProgramConfig.ProgramPath = "../" + ProgramConfig.ProgramPath;
        }

        public virtual void PrintPath()
        {
            Console.WriteLine(ProgramConfig.ProgramPath);
        }
    }
}

4.在你应用程序的Spring配置中中导入ZConfig配置

<import resource="assembly://ZConfig/ZConfig/ZConfig.xml" />

5.最后给一个使用的例子

static void Main(string[] args)
{
    var appContext = ContextRegistry.GetContext();
    IProgram program = (IProgram)appContext["Program"];
    program.PrintPath();
    program.UpdatePath();
    program.PrintPath();
    Console.ReadLine();
}

实现简介

除了一个约定用的ZConfig.IUseConfig以外还有以下几个部分

ZConfig.Pointcut

指定AOP的切入点，现在又三个实现

1.ConfigInterfacePointcut

这是另外两个Pointcut的基类，拦截所有实现了IUseConfig的类

2.ModifyConfigPointcut

不仅类要实现IUseConfig，而且方法必须标记[ModifyConfig]

3.NeedConfigPointcut

不仅类要实现IUseConfig，而且方法必须标记[NeedConfig]

ZConfig.Attribute

定义了ModifyConfigAttribute和NeedConfigAttribute用于丰富切入点的选择。

ZConfig.Advice

加载和保存的配置的实现。现在提供了三个Advice

• LoadConfigAdvice
• SaveConfigAdvice
• LoadAndSaveConfigAdvice

实现的思路是获取所有实现的IUseConfig的实例，反射迭代IUseConfig中定义的属性，使用ConfigPersistance 加载 或 保存 配置对象。

ZConfig.Persistance

定义了一个接口IConfigPersistance,用于加载和保存配置

namespace ZConfig.Persistance
{
    public interface IConfigPersistance
    {
        void LoadTo(object config);
        void Save(object config);
    }
}

还有一个XmlPersistance，使用XML序列化方式保存和加载配置对象

自定义配置

默认配置的行为是，在所有实现了IUseConfig，的类的任何方法调用前加载配置，仅在标记了[ModifyConfig]特性的方法调用后才执行回写配置。默认配置文件如下

<?xml version="1.0" encoding="utf-8" ?>
<objects xmlns="http://www.springframework.net"
         xmlns:aop="http://www.springframework.net/aop">

    <object id="ProxyCreator"
        type="Spring.Aop.Framework.AutoProxy.DefaultAdvisorAutoProxyCreator, Spring.Aop"/>

    <!--Pointcut-->
    <object id="ConfigInterfacePointcut"
            type="ZConfig.Pointcut.ConfigInterfacePointcut, ZConfig" />

    <object id="ModifyConfigPointcut"
            type="ZConfig.Pointcut.ModifyConfigPointcut, ZConfig" />

    <!--Persistance-->
    <object id="XmlPersistance"
            type="ZConfig.Persistance.XmlPersistance, ZConfig" />

    <!--Advice-->
    <object id="LoadConfigAdvice"
            type="ZConfig.Advice.LoadConfigAdvice, ZConfig">
        <property name="ConfigPersistance" ref="XmlPersistance" />
    </object>

    <object id="SaveConfigAdvice"
            type="ZConfig.Advice.SaveConfigAdvice, ZConfig">
        <property name="ConfigPersistance" ref="XmlPersistance" />
    </object>

    <!--Advisor-->
    <object type="Spring.Aop.Support.DefaultPointcutAdvisor,Spring.Aop">
        <property name="Pointcut" ref="ConfigInterfacePointcut" />
        <property name="Advice" ref="LoadConfigAdvice" />
    </object>

    <object type="Spring.Aop.Support.DefaultPointcutAdvisor,Spring.Aop">
        <property name="Pointcut" ref="ModifyConfigPointcut" />
        <property name="Advice" ref="SaveConfigAdvice" />
    </object>

</objects>

通过修改Advice的ConfigPersistance可以改变配置持久化的方式。修改Advisor中Pointcut和Advice可以改变加载和回写的时间和行为。比如所有方法调用前加载调用后回写，或者必须标记[NeedConfig]才去读取配置

已知问题

不支持多个相同类型的配置对象

现在配置文件名的规则为config.GetType().Name + ".xml"

这个导致同类型的配置实例都会存储到同一个文件中去。

不能使用GetHashCode，作为文件名称的一部分，因为默认的HashCode在每次运行时都不同。

可以考虑采用一个维护一个缓存加上更复杂的文件名管理方式，或者强制要求config有一个唯一标示符