C#反射应用之实现动态可配置可扩展框架的简单示例

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS SQL Server,基础系列 2核4GB
简介: C#反射应用之实现动态可配置可扩展框架的简单示例

设想一个场景:

我们做了一个项目,最初,只支持MySQL数据库,所以我们一般直接在项目内部定义一个类,并定义其方法

#MySqlHelper.cs
public class MySqlHelper
{
    public void Query()
    {
    }
}

使用上,当然更简单了

//项目最初,只支持MySQL
MySqlHelper mySqlHelper = new MySqlHelper();
mySqlHelper.Query();

 

隔了1个月,产品说版本升级,支持一下SQLServer吧,然后,搞开发的同学,就开始想了,你这么搞,难道我再加一个类不成,也不是不行,就是太low了,不过既然都是和数据库操作相关的类,干脆我就写个接口,定义数据库操作相关方法,然后定义和数据库相关的类来实现这个接口吧,毕竟也是要成为架构师的人嘛,怎能没有这点小想法。

于是,猿A写了一个接口

#IDBHelper.cs
public interface IDBHelper
{
    void Query();
    //void Insert();
    //void Update();
    //void Delete();
}

接着,写了2个类MySQLHelper和SQLServerHelper且都继承该接口

#MySqlHelper.cs
public class MySqlHelper:IDBHelper
{
    public void Query()
    {
    }
}
=======
#SqlServerHelper.cs
public class SqlServerHelper : IDBHelper
{
    public void Query()
    {
        //throw new NotImplementedException();
    }
}

这样,客户是哪个数据库,我就用哪种方式吧。

猿B看到了猿A的写法,大叫一声,“瞎搞”,然后开始了喷水.............

小A啊,一般来说,不同的客户采用不同的数据库,甚至可能采用多个数据库,那么,我们自然不能在代码实现中,将这部分代码写死,如果客户中间要换数据库呢?那不是还得改程序吗?既然我们做产品,当然要做成通用的嘛!像这种情况,配置文件就该派上用场了,我们可以在app.config中指定数据库种类,比如这里,我通过AppSettings节点,添加了一个key值为IDBHelperConfig的项,项内分别保存了类所在的dll和类的名称。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2" />
    </startup>
  <appSettings>
    <add key="IDBHelperConfig" value="ReflectionDemo,ReflectionDemo.MySqlHelper"/>
  </appSettings>
  <connectionStrings>
    <!--数据库连接字符串-->
    <add name="Customers" connectionString="Data Source=ElevenPC; Database=Customers; User ID=sa; Password=Password; MultipleActiveResultSets=True" providerName="System.Data.SqlClient" />
  </connectionStrings>
</configuration>

我们就可以通过反射动态加载dll,然后实现动态可配置加载方式,到这里,小心思又要来了,反射每次要写那么多代码,如果每次调用都写那么多,那将DRY原则置于何地呀,所以,就把它封装成一个简单工厂吧,这样就看起来完美了,

我们可以把上图内容封装到类SimpleFactory,代码如下

public static class SimpleFactory
{
    //通过配置文件,来决定使用哪种数据库
    static string dllName = ConfigurationManager.AppSettings["IDBHelperConfig"].Split(',')[0];
    static string typeName = ConfigurationManager.AppSettings["IDBHelperConfig"].Split(',')[1];
    public static IDBHelper CreateInstance()
    {
        Assembly assembly = Assembly.Load(dllName);
        Type type1 = assembly.GetType(typeName);
        object o = Activator.CreateInstance(type1);
        IDBHelper dBHelper = o as IDBHelper;
        return dBHelper;
    }
}

这样,操作就简单了,我们只需在调用时,调用工厂类方法,创建对象,然后即可调用相应的Query方法了

IDBHelper dBHelper = SimpleFactory.CreateInstance();
dBHelper.Query();

看上去清爽多了,就跟直接new 类是一样的。

 

那可能有小伙伴要说了,其实我没必要用反射啊,我在配置文件里定义了要使用的数据库类型,那我可以直接在工厂类里将这个值作为参数传入,然后根据这个值来生成相应的类啊,反正最后返回的都是IDBHelper对象。是的,这样的设计确实也没问题,那么,我们这里为什么要如此设计呢?这样做有什么好处呢?其实,是为了实现程序的可扩展,此话怎讲呢?

再来想象一下这个场景,如果,我们现在又要支持Oracle数据库了,按照刚刚提到的这种方式的话,那我们就需要修改源程序,在SimpleFactory类里添加对应的Oracle对象的生成逻辑,使用时在修改配置文件。

而如果是采用的上述方式的话,你发现没,我们只需要将Oracle对象对应的类库文件放到项目路径下,然后通过修改配置文件,即可完成程序的扩展,而基本无需改动源程序的任何代码。那么,你觉得哪种方式更优呢?

其实,说到这里,我们能看出来,之前将MySqlHelper.cs和SqlServerHelper.cs放在项目框架下是不合理的,因为,作为单独的数据库操作类,我们应该将其设计成单独类库,这样不仅代码结构更加合理,而且,能够实现代码的复用和扩展,这是我最终的项目架构图。

这样的话,我们就实现了一个通用的动态加载的可配置可扩展的框架示例。其实应该是挺简单的,主要就是借助反射来实现动态加载和可扩展,借助配置文件来做到可配置。

 

源码我放到了GitHub,有需要的请自取

https://github.com/IronMarmot/Samples/tree/master/MyReflection/ReflectionDemo

最新版本讲解,请关注下方公众号。

相关实践学习
如何在云端创建MySQL数据库
开始实验后,系统会自动创建一台自建MySQL的 源数据库 ECS 实例和一台 目标数据库 RDS。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
22天前
|
测试技术 C# 数据库
C# 单元测试框架 NUnit 一分钟浅谈
【10月更文挑战第17天】单元测试是软件开发中重要的质量保证手段,NUnit 是一个广泛使用的 .NET 单元测试框架。本文从基础到进阶介绍了 NUnit 的使用方法,包括安装、基本用法、参数化测试、异步测试等,并探讨了常见问题和易错点,旨在帮助开发者有效利用单元测试提高代码质量和开发效率。
132 64
|
4天前
|
开发框架 C# iOS开发
基于C#开源、功能强大、灵活的跨平台开发框架 - Uno Platform
基于C#开源、功能强大、灵活的跨平台开发框架 - Uno Platform
|
4天前
|
开发框架 网络协议 .NET
C#/.NET/.NET Core优秀项目和框架2024年10月简报
C#/.NET/.NET Core优秀项目和框架2024年10月简报
|
18天前
|
编译器 C#
c# - 运算符<<不能应用于long和long类型的操作数
在C#中,左移运算符的第二个操作数必须是 `int`类型,因此需要将 `long`类型的位移计数显式转换为 `int`类型。这种转换需要注意数据丢失和负值处理的问题。通过本文的详细说明和示例代码,相信可以帮助你在实际开发中正确使用左移运算符。
27 3
|
17天前
|
编译器 C#
c# - 运算符<<不能应用于long和long类型的操作数
在C#中,左移运算符的第二个操作数必须是 `int`类型,因此需要将 `long`类型的位移计数显式转换为 `int`类型。这种转换需要注意数据丢失和负值处理的问题。通过本文的详细说明和示例代码,相信可以帮助你在实际开发中正确使用左移运算符。
33 1
|
20天前
|
C# Python
使用wxpython开发跨平台桌面应用,对wxpython控件实现类似C#扩展函数处理的探究
【10月更文挑战第30天】使用 `wxPython` 开发跨平台桌面应用时,可以通过创建辅助类来模拟 C# 扩展函数的功能。具体步骤包括:1. 创建辅助类 `WxWidgetHelpers`;2. 在该类中定义静态方法,如 `set_button_color`;3. 在应用中调用这些方法。这种方法提高了代码的可读性和可维护性,无需修改 `wxPython` 库即可为控件添加自定义功能。但需要注意显式调用方法和避免命名冲突。
|
4天前
|
网络协议 Unix Linux
精选2款C#/.NET开源且功能强大的网络通信框架
精选2款C#/.NET开源且功能强大的网络通信框架
|
1月前
|
开发框架 前端开发 API
C#/.NET/.NET Core优秀项目和框架2024年9月简报
C#/.NET/.NET Core优秀项目和框架2024年9月简报
|
16天前
|
编译器 C#
c# - 运算符<<不能应用于long和long类型的操作数
在C#中,左移运算符的第二个操作数必须是 `int`类型,因此需要将 `long`类型的位移计数显式转换为 `int`类型。这种转换需要注意数据丢失和负值处理的问题。通过本文的详细说明和示例代码,相信可以帮助你在实际开发中正确使用左移运算符。
9 0
|
1月前
|
边缘计算 开发框架 人工智能
C#/.NET/.NET Core优秀项目和框架2024年8月简报
C#/.NET/.NET Core优秀项目和框架2024年8月简报