開箱即用簡單便捷的輕量級開源開發框架

時間  2019-11-13
標籤 即用 簡單 便捷 輕量級 開源 開發 框架 简体版
原文   原文鏈接

　　你是否是羨慕Java SpringBoot裏功能強大的@註解功能，Spring Boot倡導是一種開箱即用、方便快捷、約定優於配置的開發流程，雖然如今.NET Core也往相同的方向走，但在使用上總有點彆扭，目前市面上貌似尚未輕量級的真正意義上的開箱即用的基於.NET Core的框架。git

　　想一想多年前本身開發基於配置的DevFx開發框架，由於須要配置，形成開發人員苦不堪言，並且還容易配置錯誤，致使各類奇怪的錯誤；因而便有全新重寫DevFx框架的想法，通過N個月的奮戰，終於能夠放出來用了。github

　　框架不求功能全面，只求使用方便、靈活。sql

　　目前框架提供基於Attribute的IoC DI容器，徹底能夠面向接口編程了；提供輕量級的業務參數配置方案，將來計劃做爲集中配置的基礎；提供極簡但不失靈活的數據訪問框架，相似mybatis基於sql的數據訪問；還有基於HTTP/JSON的遠程調用方案（以優雅的本地調用方式來遠程調用）；主要是以上幾個功能。數據庫

　　框架是基於.NET Standard 2.0開發，理論上.NET Framework 4.6.1也能使用，由於框架已徹底從新重寫了，命名空間啥的都有改變，因此不兼容以前的版本，目前版本是5.0.2。編程

　　OK，show me the code。下面讓咱們來快速入門，看看怎麼個開箱即用。api

 

打開VS2019，創建基於.NET Core 2.2或3.0的控制檯項目ConsoleApp1，下面的例子是基於.NET Core 3.0的。使用NuGet安裝DevFx 5.0.2版本微信

 

 上圖，忽略DevFx.*，這是老舊版本，目前基於.NET Standard只有一個包，就是DevFxmybatis

建立業務邏輯接口和實現類app

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}";
        }
    }
}

運行下：

 固然數據訪問不只僅是查詢，還應該有CRUD、分頁以及事務才完整，這些後續會詳細展開。

 

OK，上面就是這些核心功能的展現，另外框架還支持自定義Attribute的處理方便自行擴展。

後續會比較詳細介紹實現原理以及對框架的拓展，好比服務註冊發現、配置中心等等。

有興趣的同窗能夠一塊兒共同討論維護，項目開源地址在：https://github.com/mer2/devfx

碼字不容易啊，感興趣的能夠去star下。

示例代碼在此：https://files.cnblogs.com/files/R2/ConsoleApp1.zip

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程