开箱即用简单便捷的轻量级开源开发框架

显示全部楼层 · 2019-9-26 09:17:19

　　你是不是羡慕Java SpringBoot里功能强盛的@注解功能，Spring Boot提倡是一种开箱即用、方便快捷、约定优于配置的开发流程，固然如今.NET Core也往相同的方向走，但在利用上总有点别扭，目前市面上貌似还没有轻量级的真正意义上的开箱即用的基于.NET Core的框架。

　　想想多年前自己开发基于配置的DevFx开发框架，由于必要配置，造成开发职员苦不堪言，而且还容易配置错误，导致各种奇怪的错误；于是便有全新重写DevFx框架的想法，经过N个月的奋战，终于可以放出来用了。

　　框架不求功能全面，只求利用方便、机动。

　　目前框架提供基于Attribute的IoC DI容器，完全可以面向接口编程了；提供轻量级的业务参数配置方案，未来计划作为会合配置的底子；提供极简但不失机动的数据访问框架，类似mybatis基于sql的数据访问；还有基于HTTP/JSON的长途调用方案（以优雅的本地调用方式来长途调用）；主要是以上几个功能。

　　框架是基于.NET Standard 2.0开发，理论上.NET Framework 4.6.1也能利用，由于框架已完全重新重写了，命名空间啥的都有改变，所以不兼容之前的版本，目前版本是5.0.2。

　　OK，show me the code。下面让我们来快速入门，看看怎么个开箱即用。

打开VS2019，创建基于.NET Core 2.2或3.0的控制台项目ConsoleApp1，下面的例子是基于.NET Core 3.0的。利用NuGet安装DevFx 5.0.2版本

上图，忽略DevFx.*，这是老旧版本，目前基于.NET Standard只有一个包，就是DevFx

创建业务逻辑接口和实现类

using DevFx;
namespace ConsoleApp1
{
//业务逻辑接口，[Service]特性告诉DevFx这个接口必要被DI
[Service]
public interface IMyService
{
string GetUserName(string userId);
}
}

复制代码

using DevFx;
using System;
namespace ConsoleApp1
{
//业务逻辑实现类，[Object]特性告诉DevFx这个类必要放入到IoC容器里，DevFx会扫描这个类实现了哪些接口，并做映射
[Object]
internal class MyService : IMyService
{
public string GetUserName(string userId) {
return $"{userId}_{DateTime.Now.Ticks}";
}
}
}

复制代码

开始调用逻辑

using DevFx;
using System;
namespace ConsoleApp1
{
class Program
{
static void Main(string[] args) {
//控制台步伐必要显式调用框架的初始化方法
//ASP.NET Core（通用主机）可以利用UseDevFx扩展方法来初始化框架
ObjectService.Init();
//获取接口实现类的实例
var myservice = ObjectService.GetObject<IMyService>();
Console.WriteLine(myservice.GetUserName("IamDevFx"));
//还能直接获取MyService类的实例
var myservice1 = ObjectService.GetObject<MyService>();
//2种方式获取的实例是同一个
Console.WriteLine($" myservice={myservice.GetHashCode()}{Environment.NewLine}myservice1={myservice1.GetHashCode()}");
}
}
}

复制代码

运行下：

是不是很简单？开箱即用！

接下先容下自动装配的例子

我们创建另外一个业务逻辑接口和相应的实现类，同样分别标上[Service]和[Object]

using DevFx;
namespace ConsoleApp1
{
[Service]
public interface IBizService
{
string GetUserDisplayName(string userId);
}
[Object]
internal class BizService : IBizService
{
public string GetUserDisplayName(string userId) {
return "IamBizService";
}
}
}

复制代码

改下之前的业务类MyService

using DevFx;
using System;
namespace ConsoleApp1
{
//业务逻辑实现类，[Object]特性告诉DevFx这个类必要放入到IoC容器里，DevFx会扫描这个类实现了哪些接口，并做映射
[Object]
internal class MyService : IMyService
{
//自动装配（注入）
[Autowired]
protected IBizService BizService { get; set; }
public string GetUserName(string userId) {
return $"{userId}_{DateTime.Now.Ticks}_{this.BizService.GetUserDisplayName(userId)}";
}
}
}

复制代码

运行下：

接下来先容下基于xml的配置，大概有些同学会问，.NET Core不是自带配置了么？别急，看下我们的利用方式你就清楚谁便捷了。

业务参数指的好比微信的API接口地址、APPID等步伐里必要利用的，大概一些开关之类的参数

起首界说必要承载业务参数的接口

using DevFx.Configuration;
namespace ConsoleApp1
{
//界说必要承载业务参数的接口，[SettingObject("~/myservice/weixin")]告诉框架这是一个配置承载对象
// 此中~/myservice/weixin为配置在配置文件里的路径
[SettingObject("~/myservice/weixin")]
public interface IWeixinSetting
{
string ApiUrl { get; }
string AppID { get; }
string AppKey { get; }
}
}

复制代码

利用自动装配特性，装配到业务逻辑里，我们修改下MyService类

using DevFx;
using System;
namespace ConsoleApp1
{
//业务逻辑实现类，[Object]特性告诉DevFx这个类必要放入到IoC容器里，DevFx会扫描这个类实现了哪些接口，并做映射
[Object]
internal class MyService : IMyService
{
//自动装配（注入）
[Autowired]
protected IBizService BizService { get; set; }
//配置自动注入
[Autowired]
protected IWeixinSetting WeixinSetting { get; set; }
public string GetUserName(string userId) {
return $"{userId}_{DateTime.Now.Ticks}_{this.BizService.GetUserDisplayName(userId)}_weixin={this.WeixinSetting.ApiUrl}";
}
}
}

复制代码

在项目里添加app.config，并设置为有更新就输出

app.config内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<devfx>
<myservice>
<weixin apiUrl="https://api.weixin.qq.com/sns/oauth2/access_token"
appId="1234567890" appKey="0123456789" />
</myservice>
</devfx>
</configuration>

复制代码

运行下：

末了先容下类似mybatis的数据访问是怎样开箱即用的，由于涉及到数据库，轻微复杂些，但还是很方便的。

我们以操纵MySql为例，起首必要利用NuGet安装MySql驱动包，目前框架默认利用社区版的MySql驱动：MySqlConnector

界说我们的数据访问层接口

using ConsoleApp1.Models;
using DevFx;
using DevFx.Data;
namespace ConsoleApp1.Data
{
//界说数据操纵接口，[DataService]告诉框架这是一个数据操纵接口
[DataService(GroupName = "MyService")]
public interface IMyDataService : ISessionDataService
{
EventMessage GetEventMessageByID(string id);
}
}

复制代码

在项目中，添加一个.sqlconfig文件，用来编写对应的Sql语句，并把这个文件按嵌入资源情势设置

sqlconfig内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<devfx>
<data>
<statements name="MyService">
<add name="GetEventMessageByID">
<sql>
<![CDATA[SELECT * FROM EventMessages WHERE MessageGuid = @ID]]>
</sql>
</add>
</statements>
</data>
</devfx>
</configuration>

复制代码

相信聪明的你能看出对应关系

然后就是在app.config里配置链接字符串，如下

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<devfx>
<data debug="true">
<connectionStrings>
<add name="EventMessageConnection" connectionString="Database=EventMessages;Data Source=数据库IP;User ID=数据库用户;Password=暗码;Character Set=utf8" providerName="System.Data.MySqlClient" />
</connectionStrings>
<dataStorages defaultStorage="EventMessageStorage">
<add name="EventMessageStorage" connectionName="EventMessageConnection" type="MySql" />
</dataStorages>
</data>
<myservice>
<weixin apiUrl="https://api.weixin.qq.com/sns/oauth2/access_token"
appId="1234567890" appKey="0123456789" />
</myservice>
</devfx>
</configuration>

复制代码

调整下我们MySerivce类

using ConsoleApp1.Data;
using DevFx;
using System;
namespace ConsoleApp1
{
//业务逻辑实现类，[Object]特性告诉DevFx这个类必要放入到IoC容器里，DevFx会扫描这个类实现了哪些接口，并做映射
[Object]
internal class MyService : IMyService
{
//自动装配（注入）
[Autowired]
protected IBizService BizService { get; set; }
//配置自动注入
[Autowired]
protected IWeixinSetting WeixinSetting { get; set; }
//数据访问接口自动注入
[Autowired]
protected IMyDataService MyDataService { get; set; }
public string GetUserName(string userId) {
var msg = this.MyDataService.GetEventMessageByID("0000e69f407a4b69bbf3866a499a2eb6");
var str = $"EventMessage:{msg.MessageGuid}_{msg.Category}_{msg.Priority}_{msg.CreatedTime}";
return $"{userId}_{DateTime.Now.Ticks}_{this.BizService.GetUserDisplayName(userId)}_weixin={this.WeixinSetting.ApiUrl}{Environment.NewLine}{str}";
}
}
}