开源项目启动和配置文档

1. 项目目录结构及介绍

开源项目 HangfireHttpJob 的目录结构如下：

HangfireHttpJob/
├── .gitignore          # 忽略文件列表
├── HangfireHttpJob.csproj # 项目文件
├── HangfireHttpJob.csproj.user # 项目用户文件
├── Properties/         # 属性目录
│   ├── AssemblyInfo.cs # 程序集信息文件
│   ├── Resources.Designer.cs
│   └── Settings.Designer.cs
├── app.config           # 应用程序配置文件
├── bin/                # 编译输出目录
│   ├── Debug/
│   └── Release/
├── obj/                # 编译中间文件目录
│   ├── Debug/
│   └── Release/
├── Program.cs          # 程序入口文件
└── packages/           # NuGet 包目录

目录及文件说明：

• .gitignore：用于定义哪些文件和目录应该被 Git 忽略。
• HangfireHttpJob.csproj：项目的核心文件，包含了项目的所有配置信息。
• HangfireHttpJob.csproj.user：包含项目特定用户设置的文件，通常不纳入版本控制。
• Properties/：存放项目属性相关的文件。
  • AssemblyInfo.cs：包含程序集的元数据，如版本信息。
  • Resources.Designer.cs、Settings.Designer.cs：自动生成的资源文件。
• app.config：应用程序配置文件，用于配置应用程序的运行参数。
• bin/：编译后的可执行文件和依赖库存放的目录。
• obj/：编译过程中产生的临时文件存放目录。
• Program.cs：程序的入口点，包含了应用程序的启动逻辑。
• packages/：存放 NuGet 包的目录。

2. 项目的启动文件介绍

项目的启动文件为 Program.cs，其主要内容如下：

using System;
using Hangfire.HttpJob;

namespace HangfireHttpJob
{
    class Program
    {
        static void Main(string[] args)
        {
            // 启动 Hangfire 服务
            var server = new BackgroundJobServer();

            // 启动 HTTP 作业服务
            HttpJobServer Starter = new HttpJobServer();
            Starter.Start();

            Console.WriteLine("Hangfire HttpJob Server started. Press [Enter] to exit...");
            Console.ReadLine();

            // 停止 Hangfire 服务
            server.Dispose();
        }
    }
}

在 Main 方法中，首先创建了一个 BackgroundJobServer 实例来启动 Hangfire 服务。然后创建了一个 HttpJobServer 实例并调用 Start 方法来启动 HTTP 作业服务。最后，程序进入等待状态，直到用户按下回车键，然后调用 Dispose 方法来停止 Hangfire 服务。

3. 项目的配置文件介绍

项目的配置文件为 app.config，该文件包含了应用程序的运行参数配置。以下是一些常见的配置项：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="hangfire" type="Hangfire.Config.HangfireConfigSection, Hangfire.Core" />
  </configSections>

  <hangfire>
    <storage provider="Hangfire.SqlServer.SqlServerStorage, Hangfire.SqlServer">
      <connectionString>Server=.;Database=HangfireDb;Integrated Security=True;</connectionString>
    </storage>
  </hangfire>

  <startup> 
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.1" />
  </startup>
</configuration>

配置项说明：

• <hangfire>：定义了 Hangfire 的配置。

  • <storage>：指定了 Hangfire 的存储后端，这里是 SQL Server。
    • <connectionString>：数据库连接字符串，用于连接到 Hangfire 使用的数据库。

• <startup>：定义了应用程序支持的运行时版本。

以上为开源项目 HangfireHttpJob 的启动和配置文档。