当前位置：首页 > news >正文

从学生信息管理到JSON文件读写：一个完整的C# WinForm CRUD小项目实战

news 2026/7/15 1:41:51

从学生信息管理到JSON文件读写：一个完整的C# WinForm CRUD小项目实战

在初学C# WinForm开发时，很多开发者会遇到一个共同的问题：虽然掌握了各种控件的使用方法，但如何将这些零散的知识点串联起来，构建一个真正可用的桌面应用程序？本文将带你从零开始，开发一个功能完整的学生信息管理系统，涵盖从界面设计到数据持久化的全流程。

这个项目虽然规模不大，但包含了桌面应用开发的核心要素：用户界面设计、数据绑定、事件处理和文件操作。我们选择学生信息管理作为示例场景，因为它足够简单直观，同时又涉及多种控件和业务逻辑的配合。通过这个项目，你将学会如何用WinForm构建具有实际功能的CRUD（增删改查）应用，并将数据保存到JSON文件中。

1. 项目规划与界面设计

1.1 确定功能需求

任何项目开发的第一步都是明确需求。我们的学生信息管理系统需要实现以下功能：

学生信息展示：以列表形式显示所有学生记录
信息编辑：支持添加新学生、修改现有学生信息和删除学生
数据持久化：将学生信息保存到本地文件，并在程序启动时自动加载
搜索功能：能够按姓名或学号快速查找学生

1.2 设计主界面

WinForm提供了丰富的控件库，我们需要根据功能选择合适的控件：

// 主窗体控件布局示例代码 this.Text = "学生信息管理系统"; this.Size = new Size(800, 600); // 使用TableLayoutPanel作为根容器 var mainTable = new TableLayoutPanel(); mainTable.Dock = DockStyle.Fill; mainTable.ColumnCount = 1; mainTable.RowCount = 3; mainTable.RowStyles.Add(new RowStyle(SizeType.Absolute, 50)); // 搜索栏 mainTable.RowStyles.Add(new RowStyle(SizeType.Percent, 80)); // 数据展示 mainTable.RowStyles.Add(new RowStyle(SizeType.Absolute, 50)); // 操作按钮

界面主要分为三个区域：

顶部搜索栏：包含TextBox用于输入搜索关键词和搜索按钮
中部数据展示区：使用DataGridView显示学生列表
底部操作区：放置"添加"、"编辑"、"删除"等按钮

1.3 设计编辑表单

当用户添加或编辑学生信息时，我们需要一个单独的窗体来收集信息：

// 学生编辑表单控件示例 var form = new Form(); form.Text = "学生信息"; form.Size = new Size(400, 300); var panel = new TableLayoutPanel(); panel.Dock = DockStyle.Fill; panel.ColumnCount = 2; panel.RowCount = 5; // 添加标签和输入控件 panel.Controls.Add(new Label { Text = "学号：" }, 0, 0); panel.Controls.Add(new TextBox { Name = "txtId" }, 1, 0); panel.Controls.Add(new Label { Text = "姓名：" }, 0, 1); panel.Controls.Add(new TextBox { Name = "txtName" }, 1, 1); panel.Controls.Add(new Label { Text = "性别：" }, 0, 2); var genderCombo = new ComboBox { Name = "cmbGender" }; genderCombo.Items.AddRange(new object[] { "男", "女" }); panel.Controls.Add(genderCombo, 1, 2); // 添加确定和取消按钮 var btnPanel = new FlowLayoutPanel(); btnPanel.Controls.Add(new Button { Text = "确定", Name = "btnOK" }); btnPanel.Controls.Add(new Button { Text = "取消", Name = "btnCancel" }); panel.Controls.Add(btnPanel, 1, 4);

2. 数据模型与业务逻辑

2.1 定义学生实体类

良好的数据模型是应用的基础。我们创建一个Student类来表示学生信息：

public class Student { public int Id { get; set; } public string Name { get; set; } public string Gender { get; set; } public string Phone { get; set; } public DateTime BirthDate { get; set; } public string ClassName { get; set; } // 重写ToString方法便于显示 public override string ToString() { return $"{Id} - {Name} ({Gender})"; } }

2.2 实现数据管理类

创建一个StudentService类来封装所有与学生数据相关的操作：

public class StudentService { private List<Student> _students = new List<Student>(); private readonly string _dataFile = "students.json"; public StudentService() { LoadData(); } // 添加学生 public void AddStudent(Student student) { if (_students.Any(s => s.Id == student.Id)) { throw new Exception("学号已存在"); } _students.Add(student); SaveData(); } // 更新学生信息 public void UpdateStudent(Student student) { var existing = _students.FirstOrDefault(s => s.Id == student.Id); if (existing == null) { throw new Exception("学生不存在"); } existing.Name = student.Name; existing.Gender = student.Gender; existing.Phone = student.Phone; existing.BirthDate = student.BirthDate; existing.ClassName = student.ClassName; SaveData(); } // 删除学生 public void DeleteStudent(int id) { var student = _students.FirstOrDefault(s => s.Id == id); if (student != null) { _students.Remove(student); SaveData(); } } // 获取所有学生 public List<Student> GetAllStudents() { return _students.OrderBy(s => s.Id).ToList(); } // 搜索学生 public List<Student> SearchStudents(string keyword) { return _students.Where(s => s.Name.Contains(keyword) || s.Id.ToString().Contains(keyword) || s.ClassName.Contains(keyword)) .OrderBy(s => s.Id) .ToList(); } // 加载数据 private void LoadData() { if (File.Exists(_dataFile)) { var json = File.ReadAllText(_dataFile); _students = JsonConvert.DeserializeObject<List<Student>>(json) ?? new List<Student>(); } } // 保存数据 private void SaveData() { var json = JsonConvert.SerializeObject(_students, Formatting.Indented); File.WriteAllText(_dataFile, json); } }

2.3 绑定数据到界面

DataGridView是WinForm中功能强大的数据展示控件，我们可以将学生列表绑定到它：

// 在主窗体中初始化DataGridView private void InitializeDataGridView() { dataGridView.AutoGenerateColumns = false; dataGridView.AllowUserToAddRows = false; dataGridView.SelectionMode = DataGridViewSelectionMode.FullRowSelect; // 添加列 dataGridView.Columns.Add(new DataGridViewTextBoxColumn { DataPropertyName = "Id", HeaderText = "学号", Width = 80 }); dataGridView.Columns.Add(new DataGridViewTextBoxColumn { DataPropertyName = "Name", HeaderText = "姓名", Width = 100 }); // 绑定数据 RefreshData(); } private void RefreshData() { dataGridView.DataSource = _studentService.GetAllStudents(); }

3. 实现CRUD操作

3.1 添加学生

当用户点击"添加"按钮时，我们显示编辑表单收集信息：

private void btnAdd_Click(object sender, EventArgs e) { var form = new StudentEditForm(); if (form.ShowDialog() == DialogResult.OK) { try { _studentService.AddStudent(form.Student); RefreshData(); MessageBox.Show("添加成功"); } catch (Exception ex) { MessageBox.Show(ex.Message, "错误", MessageBoxButtons.OK, MessageBoxIcon.Error); } } }

编辑表单需要将用户输入的数据转换为Student对象：

// 在StudentEditForm中 public Student Student { get; private set; } private void btnOK_Click(object sender, EventArgs e) { if (!int.TryParse(txtId.Text, out var id)) { MessageBox.Show("请输入有效的学号"); return; } if (string.IsNullOrWhiteSpace(txtName.Text)) { MessageBox.Show("请输入姓名"); return; } Student = new Student { Id = id, Name = txtName.Text.Trim(), Gender = cmbGender.SelectedItem?.ToString(), Phone = txtPhone.Text.Trim(), BirthDate = dtpBirthDate.Value, ClassName = txtClassName.Text.Trim() }; DialogResult = DialogResult.OK; Close(); }

3.2 编辑学生

编辑操作与添加类似，但需要先加载选中学生的信息：

private void btnEdit_Click(object sender, EventArgs e) { if (dataGridView.SelectedRows.Count == 0) { MessageBox.Show("请选择要编辑的学生"); return; } var student = (Student)dataGridView.SelectedRows[0].DataBoundItem; var form = new StudentEditForm(student); if (form.ShowDialog() == DialogResult.OK) { try { _studentService.UpdateStudent(form.Student); RefreshData(); MessageBox.Show("更新成功"); } catch (Exception ex) { MessageBox.Show(ex.Message, "错误", MessageBoxButtons.OK, MessageBoxIcon.Error); } } }

3.3 删除学生

删除操作相对简单，只需要确认后调用服务方法：

private void btnDelete_Click(object sender, EventArgs e) { if (dataGridView.SelectedRows.Count == 0) { MessageBox.Show("请选择要删除的学生"); return; } var student = (Student)dataGridView.SelectedRows[0].DataBoundItem; if (MessageBox.Show($"确定要删除学生 {student.Name} 吗?", "确认删除", MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.Yes) { try { _studentService.DeleteStudent(student.Id); RefreshData(); MessageBox.Show("删除成功"); } catch (Exception ex) { MessageBox.Show(ex.Message, "错误", MessageBoxButtons.OK, MessageBoxIcon.Error); } } }

4. 数据持久化与JSON处理

4.1 使用Newtonsoft.Json库

JSON是一种轻量级的数据交换格式，非常适合小型应用的数据存储。我们使用流行的Newtonsoft.Json库来处理序列化和反序列化：

// 安装NuGet包 Install-Package Newtonsoft.Json // 序列化示例 var students = new List<Student> { new Student { Id = 1, Name = "张三", Gender = "男" }, new Student { Id = 2, Name = "李四", Gender = "女" } }; string json = JsonConvert.SerializeObject(students, Formatting.Indented); File.WriteAllText("students.json", json); // 反序列化示例 string json = File.ReadAllText("students.json"); var students = JsonConvert.DeserializeObject<List<Student>>(json);

4.2 处理文件读写异常

在实际应用中，我们需要考虑文件操作可能出现的各种异常情况：

private void SaveData() { try { var json = JsonConvert.SerializeObject(_students, Formatting.Indented); // 先写入临时文件，确保数据完整性 string tempFile = Path.GetTempFileName(); File.WriteAllText(tempFile, json); // 替换原文件 if (File.Exists(_dataFile)) { File.Replace(tempFile, _dataFile, _dataFile + ".bak"); } else { File.Move(tempFile, _dataFile); } } catch (UnauthorizedAccessException) { MessageBox.Show("没有权限访问数据文件", "错误", MessageBoxButtons.OK, MessageBoxIcon.Error); } catch (IOException ex) { MessageBox.Show($"文件读写错误: {ex.Message}", "错误", MessageBoxButtons.OK, MessageBoxIcon.Error); } catch (Exception ex) { MessageBox.Show($"保存数据时发生错误: {ex.Message}", "错误", MessageBoxButtons.OK, MessageBoxIcon.Error); } }

4.3 数据备份与恢复

为了增加数据安全性，我们可以实现简单的备份和恢复功能：

public void BackupData(string backupPath) { if (!Directory.Exists(backupPath)) { Directory.CreateDirectory(backupPath); } string backupFile = Path.Combine(backupPath, $"students_backup_{DateTime.Now:yyyyMMddHHmmss}.json"); File.Copy(_dataFile, backupFile); } public bool RestoreData(string backupFile) { if (!File.Exists(backupFile)) { return false; } try { File.Copy(backupFile, _dataFile, true); LoadData(); return true; } catch { return false; } }

5. 高级功能与优化

5.1 实现搜索功能

搜索是信息管理系统的核心功能之一。我们可以实现实时搜索来提高用户体验：

private void txtSearch_TextChanged(object sender, EventArgs e) { var keyword = txtSearch.Text.Trim(); if (string.IsNullOrEmpty(keyword)) { RefreshData(); } else { dataGridView.DataSource = _studentService.SearchStudents(keyword); } }

5.2 数据验证与错误处理

良好的用户体验离不开完善的输入验证：

// 在编辑表单中添加验证 private bool ValidateInput() { if (!int.TryParse(txtId.Text, out var id) || id <= 0) { MessageBox.Show("请输入有效的学号（正整数）"); txtId.Focus(); return false; } if (string.IsNullOrWhiteSpace(txtName.Text)) { MessageBox.Show("请输入学生姓名"); txtName.Focus(); return false; } if (cmbGender.SelectedIndex < 0) { MessageBox.Show("请选择性别"); cmbGender.Focus(); return false; } if (!Regex.IsMatch(txtPhone.Text, @"^[\d-]+$")) { MessageBox.Show("请输入有效的电话号码"); txtPhone.Focus(); return false; } return true; }

5.3 使用异步操作提升响应速度

文件操作和复杂计算可能会阻塞UI线程，使用异步可以避免界面卡顿：

public async Task<List<Student>> GetAllStudentsAsync() { return await Task.Run(() => { // 模拟耗时操作 Thread.Sleep(500); return _students.OrderBy(s => s.Id).ToList(); }); } // 在窗体中调用 private async void RefreshDataAsync() { try { dataGridView.DataSource = await _studentService.GetAllStudentsAsync(); } catch (Exception ex) { MessageBox.Show(ex.Message, "错误", MessageBoxButtons.OK, MessageBoxIcon.Error); } }

5.4 添加数据导出功能

除了JSON存储，我们还可以支持其他格式的数据导出：

public void ExportToCsv(string filePath) { var sb = new StringBuilder(); // 添加表头 sb.AppendLine("学号,姓名,性别,电话,出生日期,班级"); // 添加数据行 foreach (var student in _students) { sb.AppendLine($"{student.Id},{EscapeCsv(student.Name)},{student.Gender}," + $"{EscapeCsv(student.Phone)},{student.BirthDate:yyyy-MM-dd},{EscapeCsv(student.ClassName)}"); } File.WriteAllText(filePath, sb.ToString(), Encoding.UTF8); } private string EscapeCsv(string value) { if (string.IsNullOrEmpty(value)) { return ""; } if (value.Contains(",") || value.Contains("\"") || value.Contains("\n")) { return $"\"{value.Replace("\"", "\"\"")}\""; } return value; }