超简单的C#可配置可扩展基础框架示例

本文涉及的产品
云数据库 RDS SQL Server,独享型 2核4GB
云数据库 RDS MySQL Serverless,0.5-2RCU 50GB
简介: 超简单的C#可配置可扩展基础框架示例

最近猿A开发了一个项目,最初只支持MySQL数据库,所以猿A直接在项目内部定义一个类,并定义其具体实现

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


使用上,当然更简单了。

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


隔了1个月,产品说版本升级,支持一下SqlServer吧,然后,猿A就开始想了,你这么搞,难道我再加一个类不成,也不是不行,就是太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啊,一般来说,不同的客户采用不同的数据库,甚至可能采用多个不同数据库,那么,我们自然不能在代码实现中,将数据库连接和操作等写成固定的。为啥呢?因为这样的话,那不是的针对每个数据库都得写一套固定的代码吗?如果客户中间要换数据库呢?那不是还得改程序吗?

既然我们做的是产品,当然要做成通用的嘛!首先要保证产品的普适性。当然,像这种情况其实也是很容易处理的,我们只需按如下步骤进行就可以轻松搞定了。


1.借助配置文件,我们可以在配置文件中指定数据库种类,比如这里,我在app.config中通过AppSettings节点,添加了一个key值为IDBHelperConfig的项,项内保存了使用的数据库种类。这样可用于在实例化数据库操作类时用于判断。


<?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="MySql"/>
</appSettings>
<connectionStrings>
<!--数据库连接字符串-->
<add name="Customers" connectionString="Data Source=ElevenPC; Database=Customers; User ID=sa; Password=Password; MultipleActiveResultSets=True" providerName="System.Data.SqlClient" />
</connectionStrings>
</configuration>


2.由于所有的数据库操作类都继承了IDBHelper接口,那么你可以定义一个工厂类,其接受一个参数(即配置文件里配置的值),并生成对应的数据库操作类。


这样的话,其实我们就通过配置文件实现了程序的可配置


3.但是,小A你想啊,这次增加一个SQLServer,万一下次还要增加Oracle,增加redis呢?你是不是还得修改代码,那这样的话,我们有没有一种方式能够做到一劳永逸呢,这样的话才能算的上是一个比较好的系统架构,对不对?


猿A说:要增加功能还能不修改代码,有这么神奇的方式吗?


猿B说:你啊,还是太年轻,要增加功能,修改代码肯定是必须的,但是,修改的可能只是业务代码,而跟架构没关系。还记得上次教你的反射吧。反射可以通过程序集名称和类名称来动态的创建对象。这样,如果我们的配置文件配置了数据库操作类及类所在的程序集,那么,我们就可以在工厂方法中通过反射的方式来动态的创建对象。如

<add key="IDBHelperConfig" value="ReflectionDemo,ReflectionDemo.MySqlHelper"/>


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 type = assembly.GetType(typeName);
        object o = Activator.CreateInstance(type);
        IDBHelper dBHelper = o as IDBHelper;
         return dBHelper;
    }
}


这样,操作就简单了,我们只需在调用时,调用工厂类方法,创建对象,然后即可调用相应的Query方法了,看上去清爽多了,就跟直接new出的对象是一样的调用方式。

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


即使我们下次需要增加Oracle支持,那么我们也只需将Oracle的全部操作都封装在一个单独的类库里,然后向应用程序提供该类库就可以让原来的程序支持Oracle,这就是程序的可扩展性。你明白了吗?


猿A:哇,真的耶,大佬就是厉害,感谢指点,那这样的话,我赶紧去修改我的代码,我要将接口定义以及对MySQL、SqlServer、Oracle的支持都封装到单独的类库,并且用反射的方式来实现工厂类的方法,然后在通过配置文件来指导工厂方法生产对象。


过了一小会儿...

猿A:大佬,来看一下我这个架构还有什么问题吗?


1694174981536.png


猿B:嗯,这样的实现就对啦。这其实就是一个小型通用的可配置可扩展的架构的实例。简单来说,就是利用配置文件来实现可配置,利用反射的动态加载来实现可扩展。学的不错,继续加油。


就这样,猿A在迷茫的道路上又前进了一步。


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


https://github.com/IronMarmot/Samples/tree/master/MyReflection/Reflect
相关实践学习
基于CentOS快速搭建LAMP环境
本教程介绍如何搭建LAMP环境,其中LAMP分别代表Linux、Apache、MySQL和PHP。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
19天前
|
数据可视化 网络协议 C#
C#/.NET/.NET Core优秀项目和框架2024年3月简报
公众号每月定期推广和分享的C#/.NET/.NET Core优秀项目和框架(每周至少会推荐两个优秀的项目和框架当然节假日除外),公众号推文中有项目和框架的介绍、功能特点、使用方式以及部分功能截图等(打不开或者打开GitHub很慢的同学可以优先查看公众号推文,文末一定会附带项目和框架源码地址)。注意:排名不分先后,都是十分优秀的开源项目和框架,每周定期更新分享(欢迎关注公众号:追逐时光者,第一时间获取每周精选分享资讯🔔)。
|
2月前
|
算法 BI API
C#/.NET/.NET Core优秀项目和框架2024年1月简报
C#/.NET/.NET Core优秀项目和框架2024年1月简报
|
3月前
|
IDE 前端开发 JavaScript
【C#】C# 开发环境配置(Rider 一个.NET 跨平台集成开发环境)
【1月更文挑战第26天】【C#】C# 开发环境配置(Rider 一个.NET 跨平台集成开发环境)
|
3月前
|
定位技术 C# 图形学
Unity和C#游戏编程入门:创建迷宫小球游戏示例
Unity和C#游戏编程入门:创建迷宫小球游戏示例
73 2
|
3月前
|
C#
C# 布尔值和条件语句:入门指南和实用示例
在编程中,通常需要一个只能有两个值之一的数据类型,比如: 是 / 否 开 / 关 真 / 假 为此,C# 有一个 bool 数据类型,可以取 true 或 false 的值。
71 3
|
3月前
|
存储 C#
C# 数据类型与类型转换:包含教程与示例
使用正确的数据类型对应于相应的变量是重要的;这样可以避免错误、节省时间和内存,还会使您的代码更易于维护和阅读。最常见的数据类型有:
30 0
|
3月前
|
C# C++
halcon联合c#、WPF学习笔记一(WPF配置halcon)
halcon联合c#、WPF学习笔记一(WPF配置halcon)
124 1
|
3月前
|
数据采集 开发框架 JavaScript
C#/.NET/.NET Core优秀项目和框架2023年12月简报
C#/.NET/.NET Core优秀项目和框架2023年12月简报
|
4月前
|
C#
C#开发环境配置-VS2017安装使用
C#开发环境配置-VS2017安装使用
|
4月前
|
开发框架 数据可视化 C#
C# | 上位机开发新手指南(三)框架
在上位机开发中,Windows Forms是使用最广泛的C#框架之一。Windows Forms是.NET Framework中的一个GUI框架,提供了丰富的GUI控件和易于使用的编程模型,可以快速开发Windows桌面应用程序。Windows Forms已经存在多年,并且在.NET Framework中得到广泛的支持和优化,因此在上位机开发中得到了广泛应用。除此之外,随着.NET Core的不断发展,越来越多的开发人员开始使用跨平台的C#框架进行上位机开发,例如使用Electron或Avalonia等框架开发基于Web技术的桌面应用程序。
175 0
C# | 上位机开发新手指南(三)框架