SurgingDemo 项目使用教程

1. 项目目录结构及介绍

SurgingDemo 项目的目录结构如下：

SurgingDemo/
├── docs/
├── src/
│   ├── Bill.Demo.Core/
│   ├── Bill.Demo.DapperCore/
│   ├── Bill.Demo.IModuleServices/
│   ├── Bill.Demo.ModuleServices/
│   ├── Bill.Demo.Services.Server/
│   ├── Bill.Demo.Web/
│   └── sql/
├── .gitignore
├── LICENSE
└── README.md

目录结构介绍

• docs/: 存放项目文档，如使用说明、API文档等。
• src/: 项目源代码目录。
  • Bill.Demo.Core/: 定义用户数据模型。
  • Bill.Demo.DapperCore/: 使用 Dapper 实现数据访问层，包含仓储接口和实现。
  • Bill.Demo.IModuleServices/: 定义模块服务接口。
  • Bill.Demo.ModuleServices/: 实现模块服务接口。
  • Bill.Demo.Services.Server/: 服务端项目，启动服务。
  • Bill.Demo.Web/: 客户端项目，使用 MVC 架构。
  • sql/: 存放数据库脚本，如创建表的 SQL 文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。

2. 项目启动文件介绍

服务端启动文件

服务端启动文件位于 src/Bill.Demo.Services.Server/ 目录下，主要包含以下文件：

• Program.cs: 服务端主程序入口，负责启动服务。
• Startup.cs: 配置服务端启动时的依赖注入、中间件等。

客户端启动文件

客户端启动文件位于 src/Bill.Demo.Web/ 目录下，主要包含以下文件：

• Program.cs: 客户端主程序入口，负责启动 Web 应用。
• Startup.cs: 配置客户端启动时的依赖注入、中间件等。

3. 项目配置文件介绍

数据库配置

数据库配置文件位于 src/Bill.Demo.DapperCore/DataBaseConfig.cs，主要配置数据库连接字符串：

public class DataBaseConfig
{
    public static string ConnectionString { get; set; } = "your_connection_string_here";

    public static IDbConnection GetSqlConnection(string connectionString = null)
    {
        if (string.IsNullOrEmpty(connectionString))
        {
            connectionString = ConnectionString;
        }
        IDbConnection conn = new SqlConnection(connectionString);
        conn.Open();
        return conn;
    }
}

服务注册中心配置

服务注册中心使用 Consul，配置文件位于 src/Bill.Demo.Services.Server/appsettings.json，主要配置 Consul 的地址：

{
  "Consul": {
    "Address": "http://localhost:8500"
  }
}

网关配置

网关配置文件位于 src/Surging.ApiGateway/appsettings.json，主要配置网关的端口和路由规则：

{
  "ApiGateway": {
    "Port": 8080,
    "Routes": [
      {
        "Path": "/api/user",
        "Service": "UserService"
      }
    ]
  }
}

通过以上配置，您可以顺利启动 SurgingDemo 项目，并进行基本的增删改查操作。