BrightstarDB 项目教程

1. 项目的目录结构及介绍

BrightstarDB 项目的目录结构如下：

BrightstarDB/
├── BrightstarDB.sln
├── BrightstarDB.Core/
│   ├── BrightstarDB.Core.csproj
│   ├── ...
├── BrightstarDB.Server/
│   ├── BrightstarDB.Server.csproj
│   ├── ...
├── BrightstarDB.Client/
│   ├── BrightstarDB.Client.csproj
│   ├── ...
├── BrightstarDB.Tests/
│   ├── BrightstarDB.Tests.csproj
│   ├── ...
├── docs/
│   ├── README.md
│   ├── ...
├── LICENSE
├── README.md
└── ...

目录结构介绍

• BrightstarDB.sln: 项目的解决方案文件，用于在 Visual Studio 中打开整个项目。
• BrightstarDB.Core/: 核心库目录，包含 BrightstarDB 的核心功能实现。
• BrightstarDB.Server/: 服务器端实现目录，包含 BrightstarDB 服务器的相关代码。
• BrightstarDB.Client/: 客户端库目录，包含与 BrightstarDB 服务器交互的客户端代码。
• BrightstarDB.Tests/: 测试代码目录，包含项目的单元测试和集成测试。
• docs/: 文档目录，包含项目的相关文档，如 README.md 等。
• LICENSE: 项目的开源许可证文件，BrightstarDB 使用 MIT 许可证。
• README.md: 项目的主 README 文件，包含项目的概述和基本使用说明。

2. 项目的启动文件介绍

BrightstarDB 项目的启动文件主要位于 BrightstarDB.Server 目录中。以下是主要的启动文件：

• BrightstarDB.Server.csproj: 这是 BrightstarDB 服务器端的项目文件，包含了服务器端的所有代码和依赖项。
• Program.cs: 这是 BrightstarDB 服务器的入口文件，包含了程序的启动逻辑。

Program.cs 文件介绍

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

namespace BrightstarDB.Server
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }
}

• Main 方法: 这是程序的入口点，调用 CreateHostBuilder 方法来创建和运行主机。
• CreateHostBuilder 方法: 配置 Web 主机，并指定 Startup 类作为启动类。

3. 项目的配置文件介绍

BrightstarDB 项目的配置文件主要位于 BrightstarDB.Server 目录中，常见的配置文件包括：

• appsettings.json: 这是 ASP.NET Core 应用程序的标准配置文件，用于配置应用程序的各种设置，如数据库连接字符串、日志级别等。

appsettings.json 文件示例

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "BrightstarDB": "Data Source=./brightstardb.db;Version=3;"
  }
}

• Logging: 配置日志级别，Default 设置为 Information，Microsoft 设置为 Warning。
• AllowedHosts: 配置允许访问的主机，* 表示允许所有主机。
• ConnectionStrings: 配置数据库连接字符串，BrightstarDB 指向本地数据库文件 brightstardb.db。

通过以上配置文件，可以灵活地调整 BrightstarDB 服务器的运行参数和行为。