前言
在传统的 WinForms 应用程序开发中,很多开发者使用事件驱动的设计模式,直接将业务逻辑编写在界面代码中。然而,随着应用程序的复杂性增加,单一的界面文件变得臃肿,难以测试和维护。借鉴 WPF 中 MVVM(Model-View-ViewModel)模式的设计思想,可以帮助我们更好地管理业务逻辑和数据绑定。本文将介绍如何在 WinForms 中构建一个 MVVM 框架的登录页面示例,并实现页面导航、SQLite 数据库连接及依赖注入管理。
一、项目设计与依赖引用
1. 新增winform项目
2. 创建项目结构
项目结构:按模块创建以下文件夹:
- Models:存放数据实体类。
- ViewModels:包含视图模型,负责处理业务逻辑和数据绑定。
- Views:放置WinForms窗体,充当UI界面。
- Services:用于数据库服务操作。
- IoC:配置依赖注入容器。
- Commands :配置执行命令。
- 安装所需库 :
- 使用 Microsoft.Extensions.DependencyInjection 来实现依赖注入。
- 使用 Dapper 库来连接和操作 SQLite 数据库。
- 使用SQLitePCLRaw.bundle_e_sqlite3库来处理和连接SQLite数据库。
二、创建数据实体 Model
首先创建一个 User
类来表示数据库中的用户信息。我们假设用户表 Users
包含 Id
、Username
和 Password
三个字段。
csharp
namespace WinFormMVVM.Models
{
public class User
{
public int Id { get; set; }
public string Username { get; set; }
public string Password { get; set; }
}
}
三、创建服务层 Service
创建一个初始化数据库的服务类DatabaseInitializer,配置默认用户和密码
csharp
using System.Data;
using Dapper;
using SQLitePCL;
namespace WinFormMVVM.Services
{
public class DatabaseInitializer
{
private readonly IDbConnection _dbConnection;
public DatabaseInitializer(IDbConnection dbConnection)
{
_dbConnection = dbConnection;
}
public void InitializeDatabase()
{
Batteries.Init();
const string createTableQuery = @"
CREATE TABLE IF NOT EXISTS Users (
Id INTEGER PRIMARY KEY AUTOINCREMENT,
Username TEXT NOT NULL,
Password TEXT NOT NULL
);
";
const string insertUserQuery = @"
INSERT INTO Users (Username, Password) VALUES (@Username, @Password)
";
_dbConnection.Open();
_dbConnection.Execute(createTableQuery);
// 检查是否已有用户数据,若无则添加
var existingUser = _dbConnection.QueryFirstOrDefault("SELECT * FROM Users WHERE Username = @Username", new { Username = "admin" });
if (existingUser == null)
{
_dbConnection.Execute(insertUserQuery, new { Username = "admin", Password = "password123" });
}
_dbConnection.Close();
}
}
}
在 Services
文件夹中创建 IUserService
接口及其实现 UserService
,用于从 SQLite 数据库中查询用户信息。
csharp
using System.Data;
using Dapper;
using WinFormMVVM.Models;
namespace WinFormMVVM.Services
{
public interface IUserService
{
User GetUserByUsername(string username);
}
public class UserService : IUserService
{
private readonly IDbConnection _dbConnection;
public UserService(IDbConnection dbConnection)
{
_dbConnection = dbConnection;
}
public User GetUserByUsername(string username)
{
string sql = "SELECT * FROM Users WHERE Username = @Username";
return _dbConnection.QuerySingleOrDefault<User>(sql, new { Username = username });
}
}
}
四、Commands命令实现类
RelayCommand 是一种常用的命令实现类,通常在 MVVM 模式中用于实现 ICommand 接口,但 WinForms 中并没有自带该类。如果需要使用它,可以自己定义一个简单的 RelayCommand 实现,或从一些 MVVM 库(如 CommunityToolkit.Mvvm)中引入。以下是一个自定义 RelayCommand 类的实现:
bash
using System.Windows.Input;
namespace WinFormMVVM.Commands
{
public class RelayCommand : ICommand
{
private readonly Action _execute;
private readonly Func<bool> _canExecute;
public event EventHandler CanExecuteChanged;
public RelayCommand(Action execute, Func<bool> canExecute = null)
{
_execute = execute ?? throw new ArgumentNullException(nameof(execute));
_canExecute = canExecute;
}
public bool CanExecute(object parameter)
{
return _canExecute == null || _canExecute();
}
public void Execute(object parameter)
{
_execute();
}
public void RaiseCanExecuteChanged()
{
CanExecuteChanged?.Invoke(this, EventArgs.Empty);
}
}
}
五、创建 ViewModel 类
在 MVVM 模式中,ViewModel
负责处理业务逻辑并将数据传递给视图。这里创建 LoginViewModel
类来处理登录逻辑:
csharp
using System.ComponentModel;
using System.Windows.Input;
using WinFormMVVM.Models;
using WinFormMVVM.Services;
namespace WinFormMVVM.ViewModels
{
public class LoginViewModel : INotifyPropertyChanged
{
private readonly IUserService _userService;
public event PropertyChangedEventHandler PropertyChanged;
public string Username { get; set; }
public string Password { get; set; }
public ICommand LoginCommand { get; }
public LoginViewModel(IUserService userService)
{
_userService = userService;
LoginCommand = new RelayCommand(Login);
}
private void Login()
{
var user = _userService.GetUserByUsername(Username);
if (user != null && user.Password == Password)
{
MainForm mainForm = new MainForm();
mainForm.Show();
}
else
{
// 显示登录失败的消息
}
}
}
}
LoginViewModel
通过 _userService
获取用户信息,验证成功后跳转到主页面 MainForm
。
六、配置 IoC 容器
在 IoC
文件夹中创建 IoCContainer
静态类,通过依赖注入容器来管理 IDbConnection
、IUserService
和其他ViewModel等依赖关系。
csharp
using Microsoft.Data.Sqlite;
using Microsoft.Extensions.DependencyInjection;
using System.Data;
using WinFormMVVM.Services;
using WinFormMVVM.ViewModels;
namespace WinFormMVVM.IoC
{
public static class IoCContainer
{
public static ServiceProvider Configure()
{
var services = new ServiceCollection();
services.AddSingleton<IDbConnection>(sp =>
new SqliteConnection("Data Source=./database.db")); // 设置SQLite数据库路径
services.AddSingleton<DatabaseInitializer>();
services.AddTransient<IUserService, UserService>();
services.AddSingleton<LoginViewModel>();
return services.BuildServiceProvider();
}
}
}
在这里使用了 SQLiteConnection
连接到本地的 SQLite 数据库,连接字符串 Data Source=./database.db
可以根据实际情况修改。
七、创建 View 和绑定 ViewModel
- 登录页面(LoginForm) :创建一个
LoginForm
窗体,通过构造函数注入LoginViewModel
实例并绑定到表单。
csharp
using WinFormMVVM.ViewModels;
namespace WinFormMVVM.Views
{
public partial class LoginForm : Form
{
private readonly LoginViewModel _viewModel;
public LoginForm(LoginViewModel viewModel)
{
InitializeComponent();
_viewModel = viewModel;
}
private void btnLogin_Click(object sender, EventArgs e)
{
_viewModel.Username = tb_user.Text.Trim();
_viewModel.Password = tb_password.Text.Trim();
_viewModel.LoginCommand.Execute(null);
this.Hide();
}
}
}
八、设置程序入口并启动依赖注入
在 Program.cs
文件中配置依赖注入容器,并通过容器注入 LoginViewModel
进入应用的启动界面 LoginForm
。
csharp
using System;
using System.Windows.Forms;
using Microsoft.Extensions.DependencyInjection;
using WinFormMVVM.IoC;
using WinFormMVVM.ViewModels;
using WinFormMVVM.Views;
namespace WinFormMVVM
{
static class Program
{
[STAThread]
static void Main()
{
var serviceProvider = IoCContainer.Configure();
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
var loginViewModel = serviceProvider.GetService<LoginViewModel>();
var loginForm = new LoginForm(loginViewModel);
Application.Run(loginForm);
}
}
}
创建主页面 MainForm.cs
csharp
namespace WinFormMVVM.Views
{
public partial class MainForm : Form
{
public MainForm()
{
InitializeComponent();
}
}
}
九、执行程序
通过启动程序,可以实现sqlite数据库自动创建,并且初始化默认数据,同时,通过依赖注入实现服务的运行,和页面ViewModel的注册。输入正确的账号密码,即可登录成功。
十、总结
本文介绍了如何在 WinForms 中应用 MVVM 模式,并通过 SQLite 进行数据持久化处理。通过引入依赖注入容器,服务类与视图模型的依赖关系可以在应用程序运行时被动态配置,实现了良好的解耦。这样设计的应用不仅具备更好的扩展性和可维护性,还更利于测试和重构。
借助上述框架,可以更清晰地组织 WinForms 项目,将应用逻辑、数据操作、UI 展示解耦,提升代码质量。