开始使用
准备
开发环境
Visual Studio 2022,Sqlite/SqlServer/Oracle/PostgreSQL/MySql 等等数据库。若无数据库环境,可先用 Sqlite 起步(该数据库无需任何安装和配置)。获取 QuickAdmin.Net 开发版文件
点击此处下载试用。
为方便进行项目开发演示,建议在文件系统某个位置(例如D:盘根目录下)创建以下目录结构, 将 QuickAdmin.Net 以及下边下载的的 FineUICore 文件都放入QAdmin目录,创建 Visual Studio 项目时项目位置则选source目录:
├─QAdminDemos
└─source
└─QAdmin
- 下载 FineUICore 基础版
点击 https://t.zsxq.com/RwNJX 进入 FineUI 免费社区并扫码加入,在置顶贴里找到最新版FineUICore(基础版)下载页面, 下载其中的空项目或示例项目压缩包并解压,找到项目 bin 目录下的FineUICore.dll和FineUICore.xml文件, 将它们与已下载的 QuickAdmin.Net 开发版文件放到一起。
项目 RCL 类库最初使用的 FineUICore 的版本是 7.1.1~8.1.0,如果你需要兼容旧版本 FineUICore,请与作者联系。
- 安装项目模板
已在 NuGet 提供了几个项目模板,用来生成相应 Demo 项目以了解本类库功能。在命令行输入以下命令进行安装:
dotnet new install QuickAdmin.Net.Templates
用 Visual Studio 新建项目时,在搜索模板输入框内输入 "qadmin" 即可快速列出所提供的几个模板。
创建第一个项目
先不用 QuickAdmin.Net.Templates 里的模板,按照以下步骤可快速建立一个基础的后台管理系统。
- 用 Visual Studio 内置的 "ASP.NET Core Web 应用" 模板创建一个项目:
项目位置可选取前边建议创建的目录,如:D:\QAdminDemos\source,项目框架选取 .NET 6.0+ 均可(前提:你已安装对应版本的 .NET SDK),并建议选中 "不使用顶级语句"。 - 给项目添加以下 NuGet 包:
QuickAdmin.Net.Refs: 其中包含了 QuickAdmin.Net 所需引用的其它 NuGet 包。
FreeSql.Provider.Sqlite: 先用 Sqlite 数据库进行演示,因此添加此包。 - 给项目添加程序集引用:
引用前边准备的 QuickAdmin.Net.dll、FineUICore.dll、FineUICoreRes.dll 这三个程序集。 - 删除自动创建的 Index 页面:
鼠标右击 Pages 目录下的 Index.cshtml,将其删掉。删掉后将使用 QuickAdmin.Net 内置的 Index 页面。 - 修改Program.cs,加入以下代码里的高亮部分:
using FineUICoreRes;
using QuickAdmin.RCL;
namespace WebApplication1
{
public class Program
{
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// 添加 FineUICore 静态资源
builder.Services.AddFineUICoreRes();
// 添加 QuickAdmin.Net
builder.Services.AddQuickAdmin(builder.Environment, builder.Configuration);
// Add services to the container.
builder.Services.AddRazorPages();
// 添加 控制器服务
builder.Services.AddControllers();
var app = builder.Build();
// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
app.UseExceptionHandler("/Error");
// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.UseAuthorization();
// QuickAdmin.Net 中间件配置
app.UseQuickAdmin();
app.MapRazorPages();
// 添加 属性路由映射
app.MapControllers();
app.Run();
}
}
}
- 编译,调式运行。
首次运行,将自动导航到创建系统表的页面:
QuickAdmin.Net 内置了分别与 Sqlite/SqlServer/Oracle/PostgreSQL/MySql 数据库对应的用来创建系统表的 SQL 脚本,对于这些数据库, 点击 "执行脚本创建系统表" 按钮,对于其它数据库点击 "用同步方法创建系统表" 按钮。
系统表创建好后,点击 "访问系统" 链接,即可进行登录:
这是 QuickAdmin.Net 内置的登录页,输入超级管理员账户 "admin" 及其默认密码 "admin",再输入验证码,登入系统:
这是 QuickAdmin.Net 内置的 Index 页,初次登录时会创建一些示例菜单项。点击 "系统菜单" 可去定制系统菜单项。点击 "内置页面总览" 去查看 QuickAdmin.Net 内置的功能页面有哪些。
内置的登录页、Index 页均可定制(无需编译,通过 json 配置文件进行),如系统名称、系统 Logo 等等,也可改用你自己的登录页和 Index 页,具体在后边的章节中说明。
创建示例项目
现在用 QuickAdmin.Net.Templates 里的 "QuickAdmin.Net Solution" 模板去创建项目,该模板内有建好的示例数据库(Sqlite,有组织机构、用户数据)以及简单的示例页面,可利用此项目去熟悉 QuickAdmin.Net 内置的各项功能。
该模板的 Program.cs 里还附有详细的初始化注释说明,参考 AddQuickAdmin() 扩展方法和 QuickAdminInitializationOptions 选项类文档。
AddQuickAdmin()/UseQuickAdmin() 里默认会自动初始化 Session、FreeSql 以及 FineUI,你可通过选项参数对他们的初始化过程进行定制,执行你需要的配置操作。你也可以完全自行初始化 Session/FreeSql/FineUI 等。
创建项目时若项目位置选取了前边建议的目录(如:D:\QAdminDemos\source),并选中了 "将解决方案和项目放在同一目录中",可不用调整程序集引用,直接编译运行。