缘起
哈喽大家周三好,休息了一段时间,打算准备找工作了🙃,wuli亲故有帮忙内推么,所以平时的更新学习就停滞了,不过群里的问题,我还是尽量一直在回答的。。。
今天的内容很简单,不是一个技术文章,仅仅是一个项目更新文档,给正在使用这个框架的小伙伴一个时间线,不然的话下次再 pull code 的时候,一看,又是更新一片,而且也不知道更新了啥。如果你是铁粉读者的话(至少读完第一个系列吧),肯定知道我之前是写过《38 ║自动初始化数据库》了,这篇文章也是关于如何通过项目,自动生成数据库的,那你肯定疑惑了,为啥还要写?这里有几个契机:
1、准备面试,HR打电话,很神奇的是,几乎每个人都问了是否会 MySql 或者 Oracle ?
2、平均每周都有很多小伙伴问:这个后端项目的数据库数据在哪?执行报错?
3、群里使用MySql的越来越多了,也是一直问我:你这个后端项目是否匹配 MySql ?
4、SqlServer 在跨平台上真的难 !
5、本想找伙伴帮我一起维护项目,可怜没人😂
6、每次修改数据库,都需要生成sql脚本文件,麻烦!以后sql脚本不维护了,走下文的流程。
欸~聪明的你看到这几个问题,肯定就知道为啥要写这个,没错,就像是文章标题那样,想项目同时支持多个数据库,并且可配置的生成对应数据库,只需一键,就可快速切换任何数据库。
我这周简单学了学 MySql ,虽然大学的时候自己玩儿过,但是好久没有用了,几乎都忘了,趁着这次好好研究研究 MySql ,玩儿了两天,然后整合了下项目,也完美的支持了 MySql !你可以在配置文件中,一键操作,就可以随心的切换自己喜欢的数据库,以后还会融入其他数据库(比如Oracle啥的)、主从分离等数据库技术,挖个坑以后再看。当然这里也重点夸凯旋兄,SqlSugarCore 多数据库支持完美。
好啦,内容很简单,就不多铺垫了,开门见山,主要说说哪里做了更新,以及第一次用我框架的小伙伴,如何操作。
一、初次见面,如何玩转项目?
有很多小伙伴,第一次使用,刚刚下载的时候,就被 数据库 和 Reids 搞得心烦意乱,我这里就重点说一下吧,以后这个可以作为 Blog.Core 项目的使用手册。
目前项目已经支持 Sqlserver、MySql、Oracle、Sqlite四种数据库,项目默认启动是Sqlite,大家什么都不用操作,只需要直接运行,就能看到效果,只需要开启阀门即可:
打开这两个,就可以直接使用数据了,不需要配置任何数据库环境!
如果你用其他的数据库,这里以 Mysql 举例来说:
1、配置数据库连接字符串
注意如果要使用 Mysql,记得要 引用 MySql.Data.dll 包。
关于数据库连接字符串,这里有个小伙伴总结的挺好的《各种数据库的连接字符串》,我打算以后也学学 SQLite 、Oracle 、PostgreSQL 啥的,权当练练手了。
这个很简单,我在 Blog.Core -> appsettings.json 文件中,新增了两个节点:
<pre style="color: rgb(0, 0, 0); font-family: "Courier New"; font-size: 12px; margin: 5px 8px; padding: 5px;"> "SqlServer": { "Enabled": false,//这个是开启对应数据库的阀门,都开启的话,优先级越靠上越高。 "SqlServerConnection": "Server=.;Database=WMBlogDB;User ID=sa;Password=123;",//配置连接字符串,可以参考上边的文章中查找 "ProviderName": "System.Data.SqlClient" //暂时无用 }, "MySql": { "Enabled": true, "MySqlConnection": "Server=localhost; Port=3306;Stmt=; Database=wmblogdb; Uid=root; Pwd=456;" },</pre>
多个数据库目前是互斥的,也就是优先采用最上边开启阀门的数据库,如果你想开启其他数据库,比如 Sqlite ,Oracle ,可以顺着开启节点就行,目前 SqlSugar 支持这些数据库,我尽量都加上:
<pre style="color: rgb(0, 0, 0); font-family: "Courier New"; font-size: 12px; margin: 5px 8px; padding: 5px;"> public enum DataBaseType
{
MySql = 0,
SqlServer = 1,
Sqlite = 2,
Oracle = 3,
PostgreSQL = 4 }</pre>
2、启动种子生成阀门 & 建立空数据库
配置好连接字符串后,剩下的就是很简单了,直接在下边的 SeedDBEnabled 启动 true 即可,之前是需要在代码 program.cs 中手动注释或取消注释,来实现的,现在移植到了配置文件里:
program.cs :
因为SqlSugar 不像 EFCore 那样有迁移,所以 Sqlsugar 不能自己创建数据库,所以我们需要手动创建一个空的数据库,这个很重要不要忘记。
这个时候你只需要运行项目即可,当前如果有问题,你需要清理解决方案,再执行。因为我用的是在线数据,可能数据比较慢,稍微等待。
3、对了,还有那个 Redis 配置
可能第一次使用,有的小伙伴不知道如何开启 Redis ,请参考我的文章 :《什么是Redis,为什么使用它》 ,而且要注意端口号我改成了 6319 ,不是默认的6379,具体的连接字符串,你依然可以在 appsettings.json 文件中配置:
4、最后还有 AOP 服务相关阀门
项目中写了三处 AOP 相关服务,分别是 日志AOP,内存缓存AOP,Redis缓存AOP,如果你想开启对应的服务,只需要在配置文件中开启即可,这三个可以相互叠加的,不是互斥的:
如果你想了解 AOP 以及他所应用的地方,请查看我的这篇文章:《完美基于AOP的接口性能分析》
现在已经很轻松的收集到项目中用到的所有日志了,包括,操作日志+异常日志+Sql日志:
5、在Swagger中展示 Sql 执行日志
操作很简单,功能很有效,动图如下,快速查看在线Demo:http://123.206.33.109:8081:
当然这个 swagger 里不仅有SQL日志,还有异常日志,更多功能,等待你的开发:
二、整体 Seed 开发流程是怎样的?
1、配置数据库初始化参数
为了更好的实现项目的自动化和高效性,一个框架就要尽量的减少用户的操作步骤,甚至不能修改代码,只需要配置文件就能达到相应的要求,所以我就想着把项目中需要配置的地方,都移植到 appsettings.json 文件里,目前也差不多实现了这个目标,那既然有配置,就一定要有初始化的地方,不然项目如何启动呢?没错,就拿数据库参数初始化举例:
在 Blog.Core.Common -> DB -> BaseDBConfig.cs 中,我这里对数据库相关的参数都做了初始化,以后项目中使用的都从这里获取,当然你也可以注入到服务里,全局单例使用:
<pre style="color: rgb(0, 0, 0); font-family: "Courier New"; font-size: 12px; margin: 5px 8px; padding: 5px;"> public static string ConnectionString => InitConn(); public static DataBaseType DbType = DataBaseType.SqlServer;</pre>
具体的思路可以参考源码。
2、导出数据到 JSON
有了配置文件和初始化,剩下的就是数据了,这一块我考虑了很久,有以下几个思路:
1、我开发一个 dll 文件(其实就是一个类库),然后里边有所有需要的数据,引用这个nuget,就可以直接使用,是一个List 泛型数据;//太复杂
2、手动写死到项目文件里;//代码太长,几千行
3、生成json文件,放到项目里;//直接增大项目大小
4、生成json文件,放到 GitHub 上,直接访问连接的形式;
如果你也有需要这一块的话,也可以尝试尝试,我考虑了考虑,最终采用第四种方法:
我写了一个 exe 小工具,自动将我的数据库数据,生成对应表的 JSON 文件,然后提交到 Github :
这样我也好维护,也有指定的版本数据,如果你感觉这一版本的数据不好,可以回退到上一版本的,是不是很贴心😂,主要还是数据完整性。
3、在线 Data 导入数据库
这个就是重头戏了,将 json 数据获取到,并发序列化生成 List,最后导入数据库对应表,为了代码的简洁性,我封装了几个 Helper ,感兴趣的可以去 Blog.Core.Common 查看,最后只有这一句即可:
<pre style="color: rgb(0, 0, 0); font-family: "Courier New"; font-size: 12px; margin: 5px 8px; padding: 5px;"> if (!await myContext.Db.Queryable<BlogArticle>().AnyAsync())
myContext.GetEntityDB<BlogArticle>().InsertRange(JsonHelper.ParseFormByJson<List<BlogArticle>>(GetNetData.Get(string.Format(GitJsonFileFormat,"BlogArticle")))); </pre>
这样就把全部的数据导入到数据库了,很全的,而且你还可以指定 GitHub 数据版本。
好啦,本文就暂时到这里吧,以后肯定还会增加的,主要目的就是帮助新使用的小伙伴,提供新手指南,不知道还会有哪些问题。
未完待续
今天是我入园八个月纪念日啦,时间真快!感谢各位小伙伴,谢谢!
( 吉祥金币,你申请了么?)
三、Github & Gitee
https://github.com/anjoy8/Blog.Core
https://gitee.com/laozhangIsPhi/Blog.Core
------ ♥ ------