登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

程序园 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 业界区 › 安全 ›基于HTML Help Workshop生成chm格式数据库说明文档 ...

基于HTML Help Workshop生成chm格式数据库说明文档

稼布欤 2025-6-28 09:38:20
解决的问题

现有的工具都存在一些问题：比如smart Sql，无法一次完成多个库文档生成到一个文件中，且使用过程中存在表结构过多时生成失败问题，像视图、存储过程部分生成也存在一定局限性（无DDL信息，一般没有存储过程）；故想研究一下自行代码实现。
基本思路


  • 基于ado.net读取元数据，需要啥读啥，目前只包含了表、视图、存储过程，数据库基于oracle；
  • 生成对应的html、hhp、hhc文件；
  • 调起HTML Help Workshop工具生成chm格式文件。
具体源码


  • 读取元数据
  1.     public class OracleMetadataService : IDisposable
  2.     {
  3.         private readonly OracleConnection _connection;
  5.         public OracleMetadataService(string connectionString)
  6.         {
  7.             _connection = new OracleConnection(connectionString);
  8.             _connection.Open();
  9.         }
  11.         public List<TableInfo> GetTables()
  12.         {
  13.             var tables = new List<TableInfo>();
  15.             // 优化：批量获取表基本信息和列信息
  16.             using (var cmd = new OracleCommand(
  17.                 @"SELECT table_name, comments
  18.               FROM user_tab_comments
  19.               WHERE table_type = 'TABLE'
  20.               ORDER BY table_name", _connection))
  21.             {
  22.                 using (var reader = cmd.ExecuteReader())
  23.                 {
  24.                     while (reader.Read())
  25.                     {
  26.                         var table = new TableInfo
  27.                         {
  28.                             TableName = reader["table_name"].ToString(),
  29.                             Comments = reader["comments"].ToString()
  30.                         };
  31.                         table.Columns = GetColumns(table.TableName);
  32.                         SetPrimaryKeys(table);
  33.                         SetForeignKeys(table);
  34.                         tables.Add(table);
  35.                     }
  36.                 }
  37.             }
  39.             Console.WriteLine("表信息获取完成");
  41.             return tables;
  42.         }
  44.         private List<ColumnInfo> GetColumns(string tableName)
  45.         {
  46.             var columns = new List<ColumnInfo>();
  48.             using (var cmd = new OracleCommand(
  49.                 @"SELECT
  50.                 tc.column_name, data_type, data_length, data_precision, data_scale,
  51.                 nullable, data_default, comments
  52.               FROM user_tab_columns tc
  53.               LEFT JOIN user_col_comments cc ON tc.table_name = cc.table_name AND tc.column_name = cc.column_name
  54.               WHERE tc.table_name = :tableName
  55.               ORDER BY column_id", _connection))
  56.             {
  57.                 cmd.Parameters.Add("tableName", OracleDbType.Varchar2).Value = tableName;
  59.                 using (var reader = cmd.ExecuteReader())
  60.                 {
  61.                     while (reader.Read())
  62.                     {
  63.                         columns.Add(new ColumnInfo
  64.                         {
  65.                             ColumnName = reader["column_name"].ToString(),
  66.                             DataType = reader["data_type"].ToString(),
  67.                             DataLength = reader["data_length"] as int?,
  68.                             DataPrecision = reader["data_precision"] as int?,
  69.                             DataScale = reader["data_scale"] as int?,
  70.                             Nullable = reader["nullable"].ToString(),
  71.                             DefaultValue = reader["data_default"]?.ToString(),
  72.                             Comments = reader["comments"]?.ToString()
  73.                         });
  74.                     }
  75.                 }
  76.             }
  78.             return columns;
  79.         }
  81.         private void SetPrimaryKeys(TableInfo table)
  82.         {
  83.             using (var cmd = new OracleCommand(
  84.                 @"SELECT cols.column_name
  85.               FROM user_constraints cons, user_cons_columns cols
  86.               WHERE cons.constraint_type = 'P'
  87.               AND cons.constraint_name = cols.constraint_name
  88.               AND cons.table_name = :tableName", _connection))
  89.             {
  90.                 cmd.Parameters.Add("tableName", OracleDbType.Varchar2).Value = table.TableName;
  92.                 using (var reader = cmd.ExecuteReader())
  93.                 {
  94.                     while (reader.Read())
  95.                     {
  96.                         var columnName = reader["column_name"].ToString();
  97.                         var column = table.Columns.Find(c => c.ColumnName == columnName);
  98.                         if (column != null)
  99.                         {
  100.                             column.IsPrimaryKey = true;
  101.                         }
  102.                     }
  103.                 }
  104.             }
  105.         }
  107.         private void SetForeignKeys(TableInfo table)
  108.         {
  109.             using (var cmd = new OracleCommand(
  110.                 @"SELECT cols.column_name
  111.               FROM user_constraints cons, user_cons_columns cols
  112.               WHERE cons.constraint_type = 'R'
  113.               AND cons.constraint_name = cols.constraint_name
  114.               AND cons.table_name = :tableName", _connection))
  115.             {
  116.                 cmd.Parameters.Add("tableName", OracleDbType.Varchar2).Value = table.TableName;
  118.                 using (var reader = cmd.ExecuteReader())
  119.                 {
  120.                     while (reader.Read())
  121.                     {
  122.                         var columnName = reader["column_name"].ToString();
  123.                         var column = table.Columns.Find(c => c.ColumnName == columnName);
  124.                         if (column != null)
  125.                         {
  126.                             column.IsForeignKey = true;
  127.                         }
  128.                     }
  129.                 }
  130.             }
  131.         }
  133.         public List<ViewInfo> GetViews(string owner)
  134.         {
  135.             var views = new List<ViewInfo>();
  137.             // 获取视图基本信息
  138.             using (var cmd = new OracleCommand(
  139.                 @"SELECT view_name, text, comments
  140.               FROM user_views v
  141.               LEFT JOIN user_tab_comments tc ON v.view_name = tc.table_name
  142.               ORDER BY view_name", _connection))
  143.             {
  144.                 using (var reader = cmd.ExecuteReader())
  145.                 {
  146.                     while (reader.Read())
  147.                     {
  148.                         views.Add(new ViewInfo
  149.                         {
  150.                             ViewName = reader["view_name"].ToString(),
  151.                             //Definition = reader.GetOracleClob(0)?.Value,
  152.                             Comments = reader["comments"]?.ToString()
  153.                         });
  154.                     }
  155.                 }
  156.             }
  158.             Console.WriteLine($"视图基本信息获取完成");
  160.             // 获取每张视图的列信息
  161.             foreach (var view in views)
  162.             {
  163.                 view.Definition = GetViewDDL(_connection, view.ViewName, owner);
  164.                 view.Columns = GetColumns(view.ViewName);
  165.                 Console.WriteLine($"视图[{view.ViewName}]列信息获取完成");
  166.             }
  168.             return views;
  169.         }
  171.         static string GetViewDDL(OracleConnection connection, string viewName, string schema)
  172.         {
  173.             string sql = @"
  174.                 SELECT DBMS_METADATA.GET_DDL('VIEW', :viewName, :schema)
  175.                 FROM DUAL";
  177.             using (OracleCommand command = new OracleCommand(sql, connection))
  178.             {
  179.                 command.Parameters.Add(":viewName", viewName);
  180.                 command.Parameters.Add(":schema", schema);
  182.                 command.InitialLOBFetchSize = 1000000;
  183.                 object result = command.ExecuteScalar();
  184.                 return result != null ? result.ToString() : string.Empty;
  185.             }
  186.         }
  188.         public List<ProcedureInfo> GetProcedures()
  189.         {
  190.             var procedures = new List<ProcedureInfo>();
  192.             // 获取存储过程和函数基本信息
  193.             using (var cmd = new OracleCommand(
  194.                 @"SELECT object_name, object_type, status, created, last_ddl_time
  195.               FROM user_objects
  196.               WHERE object_type IN ('PROCEDURE', 'FUNCTION')
  197.               ORDER BY object_type, object_name", _connection))
  198.             {
  199.                 using (var reader = cmd.ExecuteReader())
  200.                 {
  201.                     while (reader.Read())
  202.                     {
  203.                         procedures.Add(new ProcedureInfo
  204.                         {
  205.                             ProcedureName = reader["object_name"].ToString(),
  206.                             ProcedureType = reader["object_type"].ToString()
  207.                         });
  208.                     }
  209.                 }
  210.             }
  212.             Console.WriteLine($"存储过程基本信息获取完成");
  214.             // 获取每个对象的详细信息和参数
  215.             foreach (var proc in procedures)
  216.             {
  217.                 // 获取源代码
  218.                 using (var cmd = new OracleCommand(
  219.                     @"SELECT text
  220.                   FROM user_source
  221.                   WHERE name = :procName
  222.                   AND type = :procType
  223.                   ORDER BY line", _connection))
  224.                 {
  225.                     cmd.Parameters.Add("procName", OracleDbType.Varchar2).Value = proc.ProcedureName;
  226.                     cmd.Parameters.Add("procType", OracleDbType.Varchar2).Value = proc.ProcedureType;
  228.                     var source = new System.Text.StringBuilder();
  229.                     using (var reader = cmd.ExecuteReader())
  230.                     {
  231.                         while (reader.Read())
  232.                         {
  233.                             source.AppendLine(reader["text"].ToString());
  234.                         }
  235.                     }
  236.                     proc.SourceCode = source.ToString();
  237.                 }
  239.                 // 获取参数信息
  240.                 proc.Parameters = GetProcedureParameters(proc.ProcedureName);
  242.                 // 如果是函数，获取返回类型
  243.                 if (proc.ProcedureType == "FUNCTION")
  244.                 {
  245.                     using (var cmd = new OracleCommand(
  246.                         @"SELECT data_type
  247.                       FROM user_arguments
  248.                       WHERE object_name = :procName
  249.                       AND argument_name IS NULL", _connection))
  250.                     {
  251.                         cmd.Parameters.Add("procName", OracleDbType.Varchar2).Value = proc.ProcedureName;
  252.                         proc.ReturnType = cmd.ExecuteScalar()?.ToString();
  253.                     }
  254.                 }
  256.                 //// 获取注释
  257.                 //using (var cmd = new OracleCommand(
  258.                 //    @"SELECT comments
  259.                 //  FROM user_procedures
  260.                 //  WHERE object_name = :procName
  261.                 //  AND object_type = :procType", _connection))
  262.                 //{
  263.                 //    cmd.Parameters.Add("procName", OracleDbType.Varchar2).Value = proc.ProcedureName;
  264.                 //    cmd.Parameters.Add("procType", OracleDbType.Varchar2).Value = proc.ProcedureType;
  265.                 //    proc.Comments = cmd.ExecuteScalar()?.ToString();
  266.                 //}
  268.                 Console.WriteLine($"存储过程[{proc.ProcedureName}]详细信息获取完成");
  269.             }
  271.             return procedures;
  272.         }
  274.         private List<ParameterInfo> GetProcedureParameters(string procedureName)
  275.         {
  276.             var parameters = new List<ParameterInfo>();
  278.             using (var cmd = new OracleCommand(
  279.                 @"SELECT argument_name, data_type, in_out, position
  280.               FROM user_arguments
  281.               WHERE object_name = :procName
  282.               AND argument_name IS NOT NULL
  283.               ORDER BY position", _connection))
  284.             {
  285.                 cmd.Parameters.Add("procName", OracleDbType.Varchar2).Value = procedureName;
  287.                 using (var reader = cmd.ExecuteReader())
  288.                 {
  289.                     while (reader.Read())
  290.                     {
  291.                         parameters.Add(new ParameterInfo
  292.                         {
  293.                             ParameterName = reader["argument_name"].ToString(),
  294.                             DataType = reader["data_type"].ToString(),
  295.                             InOut = reader["in_out"].ToString(),
  296.                             Position = reader["position"] as int?
  297.                         });
  298.                     }
  299.                 }
  300.             }
  302.             return parameters;
  303.         }
  305.         public void Dispose()
  306.         {
  307.             _connection?.Close();
  308.             _connection?.Dispose();
  309.         }
  310.     }
复制代码

  • 生成html、hhp、hhc文件
  1.     public class HtmlGeneratorService
  2.     {
  3.         private readonly string _outputDirectory;
  5.         public HtmlGeneratorService(string outputDirectory)
  6.         {
  7.             _outputDirectory = outputDirectory;
  8.             Directory.CreateDirectory(_outputDirectory);
  9.         }
  11.         public void GenerateHtmlFiles(Dictionary<string, Tuple<List<TableInfo>, List<ViewInfo>, List<ProcedureInfo>>> dic)
  12.         {
  13.             GenerateIndexFile(dic);
  14.             foreach (var item in dic)
  15.             {
  16.                 GenerateTablesFiles(item.Key, item.Value.Item1);
  17.                 GenerateViewsFiles(item.Key, item.Value.Item2);
  18.                 GenerateProceduresFiles(item.Key, item.Value.Item3);
  19.             }
  20.             GenerateStyleSheet();
  21.         }
  23.         private void GenerateIndexFile(Dictionary<string, Tuple<List<TableInfo>, List<ViewInfo>, List<ProcedureInfo>>> dic)
  24.         {
  25.             var sb = new StringBuilder();
  26.             sb.AppendLine("<!DOCTYPE html>");
  27.             sb.AppendLine("<html>");
  28.             sb.AppendLine("<head>");
  29.             sb.AppendLine($"<title>数据库说明文档</title>");
  30.             sb.AppendLine("<link rel="stylesheet" href="styles.css">");
  31.             sb.AppendLine("</head>");
  32.             sb.AppendLine("<body>");
  33.             sb.AppendLine($"<h1>数据库说明文档</h1>");
  35.             foreach (var item in dic)
  36.             {
  37.                 sb.AppendLine($"<h2>{item.Key}</h2>");
  39.                 // 表目录
  40.                 sb.AppendLine("<h3>Tables</h3>");
  41.                 sb.AppendLine("<ul>");
  42.                 foreach (var table in item.Value.Item1)
  43.                 {
  44.                     sb.AppendLine($"<li>{table.TableName} - {table.Comments}</li>");
  45.                 }
  46.                 sb.AppendLine("</ul>");
  48.                 // 视图目录
  49.                 sb.AppendLine("<h3>Views</h3>");
  50.                 sb.AppendLine("<ul>");
  51.                 foreach (var view in item.Value.Item2)
  52.                 {
  53.                     sb.AppendLine($"<li>{view.ViewName} - {view.Comments}</li>");
  54.                 }
  55.                 sb.AppendLine("</ul>");
  57.                 // 存储过程和函数目录
  58.                 sb.AppendLine("<h3>Procedures and Functions</h3>");
  59.                 sb.AppendLine("<ul>");
  60.                 foreach (var proc in item.Value.Item3)
  61.                 {
  62.                     sb.AppendLine($"<li>{proc.ProcedureName} ({proc.ProcedureType})</li>");
  63.                 }
  64.                 sb.AppendLine("</ul>");
  66.             }
  68.             sb.AppendLine("</body>");
  69.             sb.AppendLine("</html>");
  71.             File.WriteAllText(Path.Combine(_outputDirectory, "index.html"), sb.ToString(), Encoding.UTF8);
  72.         }
  74.         private void GenerateTablesFiles(string owner, List<TableInfo> tables)
  75.         {
  76.             var tablesDir = Path.Combine(_outputDirectory, owner, "tables");
  77.             Directory.CreateDirectory(tablesDir);
  79.             foreach (var table in tables)
  80.             {
  81.                 var sb = new StringBuilder();
  82.                 sb.AppendLine("<!DOCTYPE html>");
  83.                 sb.AppendLine("<html>");
  84.                 sb.AppendLine("<head>");
  85.                 sb.AppendLine($"<title>Table: {table.TableName}</title>");
  86.                 sb.AppendLine("<link rel="stylesheet" href="../../styles.css">");
  87.                 sb.AppendLine("</head>");
  88.                 sb.AppendLine("<body>");
  89.                 sb.AppendLine($"<h1>Table: {table.TableName}</h1>");
  90.                 sb.AppendLine($"<p>{table.Comments}</p>");
  92.                 sb.AppendLine("<h2>Columns</h2>");
  93.                 sb.AppendLine("<table class="gridtable">");
  94.                 sb.AppendLine("<tr>");
  95.                 sb.AppendLine("<th>Name</th>");
  96.                 sb.AppendLine("<th>Type</th>");
  97.                 sb.AppendLine("<th>Length</th>");
  98.                 sb.AppendLine("<th>Precision</th>");
  99.                 sb.AppendLine("<th>Scale</th>");
  100.                 sb.AppendLine("<th>Nullable</th>");
  101.                 sb.AppendLine("<th>Default</th>");
  102.                 sb.AppendLine("<th>PK</th>");
  103.                 sb.AppendLine("<th>FK</th>");
  104.                 sb.AppendLine("<th>Description</th>");
  105.                 sb.AppendLine("</tr>");
  107.                 foreach (var column in table.Columns)
  108.                 {
  109.                     sb.AppendLine("<tr>");
  110.                     sb.AppendLine($"<td>{column.ColumnName}</td>");
  111.                     sb.AppendLine($"<td>{column.DataType}</td>");
  112.                     sb.AppendLine($"<td>{column.DataLength}</td>");
  113.                     sb.AppendLine($"<td>{column.DataPrecision}</td>");
  114.                     sb.AppendLine($"<td>{column.DataScale}</td>");
  115.                     sb.AppendLine($"<td>{column.Nullable}</td>");
  116.                     sb.AppendLine($"<td>{column.DefaultValue}</td>");
  117.                     sb.AppendLine($"<td>{(column.IsPrimaryKey ? "✓" : "")}</td>");
  118.                     sb.AppendLine($"<td>{(column.IsForeignKey ? "✓" : "")}</td>");
  119.                     sb.AppendLine($"<td>{column.Comments}</td>");
  120.                     sb.AppendLine("</tr>");
  121.                 }
  123.                 sb.AppendLine("</table>");
  124.                 sb.AppendLine("<p>Back to Index</p>");
  125.                 sb.AppendLine("</body>");
  126.                 sb.AppendLine("</html>");
  128.                 File.WriteAllText(Path.Combine(tablesDir, $"{table.TableName}.html"), sb.ToString(), Encoding.UTF8);
  129.             }
  130.         }
  132.         private void GenerateViewsFiles(string owner, List<ViewInfo> views)
  133.         {
  134.             var viewsDir = Path.Combine(_outputDirectory, owner, "views");
  135.             Directory.CreateDirectory(viewsDir);
  137.             foreach (var view in views)
  138.             {
  139.                 var sb = new StringBuilder();
  140.                 sb.AppendLine("<!DOCTYPE html>");
  141.                 sb.AppendLine("<html>");
  142.                 sb.AppendLine("<head>");
  143.                 sb.AppendLine($"<title>View: {view.ViewName}</title>");
  144.                 sb.AppendLine("<link rel="stylesheet" href="../../styles.css">");
  145.                 sb.AppendLine("</head>");
  146.                 sb.AppendLine("<body>");
  147.                 sb.AppendLine($"<h1>View: {view.ViewName}</h1>");
  148.                 sb.AppendLine($"<p>{view.Comments}</p>");
  150.                 sb.AppendLine("<h2>Columns</h2>");
  151.                 sb.AppendLine("<table class="gridtable">");
  152.                 sb.AppendLine("<tr>");
  153.                 sb.AppendLine("<th>Name</th>");
  154.                 sb.AppendLine("<th>Type</th>");
  155.                 sb.AppendLine("<th>Length</th>");
  156.                 sb.AppendLine("<th>Precision</th>");
  157.                 sb.AppendLine("<th>Scale</th>");
  158.                 sb.AppendLine("<th>Nullable</th>");
  159.                 sb.AppendLine("<th>Description</th>");
  160.                 sb.AppendLine("</tr>");
  162.                 foreach (var column in view.Columns)
  163.                 {
  164.                     sb.AppendLine("<tr>");
  165.                     sb.AppendLine($"<td>{column.ColumnName}</td>");
  166.                     sb.AppendLine($"<td>{column.DataType}</td>");
  167.                     sb.AppendLine($"<td>{column.DataLength}</td>");
  168.                     sb.AppendLine($"<td>{column.DataPrecision}</td>");
  169.                     sb.AppendLine($"<td>{column.DataScale}</td>");
  170.                     sb.AppendLine($"<td>{column.Nullable}</td>");
  171.                     sb.AppendLine($"<td>{column.Comments}</td>");
  172.                     sb.AppendLine("</tr>");
  173.                 }
  175.                 sb.AppendLine("</table>");
  177.                 sb.AppendLine("<h2>Definition</h2>");
  178.                 sb.AppendLine("<pre>");
  179.                 sb.AppendLine(view.Definition);
  180.                 sb.AppendLine("</pre>");
  182.                 sb.AppendLine("<p>Back to Index</p>");
  183.                 sb.AppendLine("</body>");
  184.                 sb.AppendLine("</html>");
  186.                 File.WriteAllText(Path.Combine(viewsDir, $"{view.ViewName}.html"), sb.ToString(), Encoding.UTF8);
  187.             }
  188.         }
  190.         private void GenerateProceduresFiles(string owner, List<ProcedureInfo> procedures)
  191.         {
  192.             var procsDir = Path.Combine(_outputDirectory, owner, "procedures");
  193.             Directory.CreateDirectory(procsDir);
  195.             foreach (var proc in procedures)
  196.             {
  197.                 var sb = new StringBuilder();
  198.                 sb.AppendLine("<!DOCTYPE html>");
  199.                 sb.AppendLine("<html>");
  200.                 sb.AppendLine("<head>");
  201.                 sb.AppendLine($"<title>{proc.ProcedureType}: {proc.ProcedureName}</title>");
  202.                 sb.AppendLine("<link rel="stylesheet" href="../../styles.css">");
  203.                 sb.AppendLine("</head>");
  204.                 sb.AppendLine("<body>");
  205.                 sb.AppendLine($"<h1>{proc.ProcedureType}: {proc.ProcedureName}</h1>");
  206.                 sb.AppendLine($"<p>{proc.Comments}</p>");
  208.                 if (proc.ProcedureType == "FUNCTION" && !string.IsNullOrEmpty(proc.ReturnType))
  209.                 {
  210.                     sb.AppendLine($"<p>Return Type: {proc.ReturnType}</p>");
  211.                 }
  213.                 if (proc.Parameters.Count > 0)
  214.                 {
  215.                     sb.AppendLine("<h2>Parameters</h2>");
  216.                     sb.AppendLine("<table class="gridtable">");
  217.                     sb.AppendLine("<tr>");
  218.                     sb.AppendLine("<th>Name</th>");
  219.                     sb.AppendLine("<th>Type</th>");
  220.                     sb.AppendLine("<th>In/Out</th>");
  221.                     sb.AppendLine("<th>Position</th>");
  222.                     sb.AppendLine("</tr>");
  224.                     foreach (var param in proc.Parameters)
  225.                     {
  226.                         sb.AppendLine("<tr>");
  227.                         sb.AppendLine($"<td>{param.ParameterName}</td>");
  228.                         sb.AppendLine($"<td>{param.DataType}</td>");
  229.                         sb.AppendLine($"<td>{param.InOut}</td>");
  230.                         sb.AppendLine($"<td>{param.Position}</td>");
  231.                         sb.AppendLine("</tr>");
  232.                     }
  234.                     sb.AppendLine("</table>");
  235.                 }
  237.                 sb.AppendLine("<h2>Source Code</h2>");
  238.                 sb.AppendLine("<pre>");
  239.                 sb.AppendLine(proc.SourceCode);
  240.                 sb.AppendLine("</pre>");
  242.                 sb.AppendLine("<p>Back to Index</p>");
  243.                 sb.AppendLine("</body>");
  244.                 sb.AppendLine("</html>");
  246.                 File.WriteAllText(Path.Combine(procsDir, $"{proc.ProcedureName}.html"), sb.ToString(), Encoding.UTF8);
  247.             }
  248.         }
  250.         private void GenerateStyleSheet()
  251.         {
  252.             var css = @"
  253. body {
  254.     font-family: Consolas, monospace;
  255.     line -height: 1.6;
  256.     margin: 20px;
  257.     color: #808080;
  258. }
  260. h1, h2, h3 {
  261.     color: #0066cc;
  262. }
  264. table.gridtable {
  265.     width: 100%;
  266.     border-collapse: collapse;
  267.     margin: 15px 0;
  268. }
  270. table.gridtable th {
  271.     background-color: #006400;
  272.     color: white;
  273.     text-align: center;
  274.     padding: 3px;
  275. }
  277. table.gridtable td {
  278.     border:  #ddd;
  279.     padding: 3px;
  280. }
  282. table.gridtable tr:nth-child(even) {
  283.     background-color: #f2f2f2;
  284. }
  286. pre {
  287.     background-color: #f5f5f5;
  288.     padding: 10px;
  289.     border-radius: 5px;
  290.     overflow-x: auto;
  291. }
  293. a {
  294.     color: #A52A2A;
  295.     text-decoration: none;
  296. }
  298. a:hover {
  299.     text-decoration: underline;
  300. }
  302. ";
  304.             File.WriteAllText(Path.Combine(_outputDirectory, "styles.css"), css);
  305.         }
  306.     }
复制代码

  • 生成chm文件
  1.     public class ChmCompiler
  2.     {
  3.         private readonly string _htmlHelpCompilerPath;
  5.         public ChmCompiler(string htmlHelpCompilerPath)
  6.         {
  7.             _htmlHelpCompilerPath = htmlHelpCompilerPath;
  8.         }
  10.         public bool Compile(string projectFilePath, string outputChmPath)
  11.         {
  12.             if (!File.Exists(_htmlHelpCompilerPath))
  13.             {
  14.                 throw new FileNotFoundException("HTML Help Compiler (hhc.exe) not found at the specified path.");
  15.             }
  17.             if (!File.Exists(projectFilePath))
  18.             {
  19.                 throw new FileNotFoundException("HHP project file not found.");
  20.             }
  22.             try
  23.             {
  24.                 var process = new Process
  25.                 {
  26.                     StartInfo = new ProcessStartInfo
  27.                     {
  28.                         FileName = _htmlHelpCompilerPath,
  29.                         Arguments = $""{projectFilePath}"",
  30.                         UseShellExecute = false,
  31.                         CreateNoWindow = true,
  32.                         RedirectStandardOutput = true,
  33.                         RedirectStandardError = true
  34.                     }
  35.                 };
  37.                 process.Start();
  38.                 process.WaitForExit(60 * 1000);
  40.                 //if (process.ExitCode != 0)
  41.                 //{
  42.                 //    var error = process.StandardError.ReadToEnd();
  43.                 //    throw new Exception($"CHM compilation failed with error: {error}");
  44.                 //}
  46.                 // 检查生成的CHM文件是否存在
  47.                 return File.Exists(outputChmPath);
  48.             }
  49.             catch (Exception ex)
  50.             {
  51.                 throw new Exception("Error during CHM compilation: " + ex.Message, ex);
  52.             }
  53.         }
  55.         public void CreateHhpFile(string outputDirectory, string projectName)
  56.         {
  57.             var hhpContent = $@"[OPTIONS]
  58. Compatibility=1.1 or later
  59. Compiled file={projectName}.chm
  60. Contents file={projectName}.hhc
  61. Default topic=index.html
  62. Display compile progress=No
  63. Full-text search=Yes
  64. Language=0x409 English (United States)
  65. Title={projectName} Database Documentation
  67. [FILES]
  68. ";
  70.             // 添加所有HTML文件
  71.             var htmlFiles = Directory.GetFiles(outputDirectory, "*.html", SearchOption.AllDirectories);
  72.             foreach (var file in htmlFiles)
  73.             {
  74.                 var relativePath = file.Substring(outputDirectory.Length + 1);
  75.                 hhpContent += relativePath + "\n";
  76.             }
  78.             // 添加CSS文件
  79.             hhpContent += "styles.css\n";
  81.             File.WriteAllText(Path.Combine(outputDirectory, $"{projectName}.hhp"), hhpContent);
  83.             // 创建目录文件 (.hhc)
  85.             CreateHhcFile(outputDirectory, projectName);
  86.         }
  88.         private void CreateHhcFile(string outputDirectory, string projectName)
  89.         {
  90.             var hhcContent = new StringBuilder(@"<!DOCTYPE HTML PUBLIC ""-//IETF//DTD HTML//EN"">
  91. <HTML>
  92. <HEAD>
  93. <meta name=""GENERATOR"" content=""Microsoft® HTML Help Workshop 4.1"">
  95. </HEAD>
  96. <BODY>
  97. <OBJECT type=""text/site properties"">
  98.     <param name=""Window Styles"" value=""0x800025"">
  99. </OBJECT>
  100. <UL>
  101.     <LI> <OBJECT type=""text/sitemap"">
  102.         <param name=""Name"" value=""Database Documentation"">
  103.         <param name=""Local"" value=""index.html"">
  104.         </OBJECT>
  105.     <UL>");
  107.             // 获取所有Owner
  108.             var owners = GetAllOwners(outputDirectory);
  110.             foreach (var owner in owners)
  111.             {
  112.                 hhcContent.AppendLine($@"
  113.         <LI> <OBJECT type=""text/sitemap"">
  114.             <param name=""Name"" value=""{owner}"">
  115.             </OBJECT>
  116.         <UL>");
  118.                 // 添加Tables分组
  119.                 hhcContent.AppendLine($@"
  120.             <LI> <OBJECT type=""text/sitemap"">
  121.                 <param name=""Name"" value=""Tables"">
  122.                 </OBJECT>
  123.             <UL>");
  125.                 AddFilesToContent(hhcContent, Path.Combine(outputDirectory, owner, "tables"), outputDirectory);
  127.                 hhcContent.AppendLine($@"
  128.             </UL>");
  130.                 // 添加Views分组
  131.                 hhcContent.AppendLine($@"
  132.             <LI> <OBJECT type=""text/sitemap"">
  133.                 <param name=""Name"" value=""Views"">
  134.                 </OBJECT>
  135.             <UL>");
  137.                 AddFilesToContent(hhcContent, Path.Combine(outputDirectory, owner, "views"), outputDirectory);
  139.                 hhcContent.AppendLine($@"
  140.             </UL>");
  142.                 // 添加Procedures分组
  143.                 hhcContent.AppendLine($@"
  144.             <LI> <OBJECT type=""text/sitemap"">
  145.                 <param name=""Name"" value=""Procedures and Functions"">
  146.                 </OBJECT>
  147.             <UL>");
  149.                 AddFilesToContent(hhcContent, Path.Combine(outputDirectory, owner, "procedures"), outputDirectory);
  151.                 hhcContent.AppendLine($@"
  152.             </UL>");
  154.                 hhcContent.AppendLine($@"
  155.         </UL>");
  156.             }
  158.             hhcContent.AppendLine($@"
  159.     </UL>
  160. </UL>
  161. </BODY>
  162. </HTML>");
  164.             File.WriteAllText(Path.Combine(outputDirectory, $"{projectName}.hhc"), hhcContent.ToString());
  165.         }
  167.         // 获取所有Owner的辅助方法
  168.         private List<string> GetAllOwners(string outputDirectory)
  169.         {
  170.             // 方法1：从目录结构中获取
  171.             return Directory.GetDirectories(outputDirectory)
  172.                 .Select(d => new DirectoryInfo(d).Name)
  173.                 .ToList();
  175.             // 方法2：从数据库中获取（需要实现）
  176.             // return GetOwnersFromDatabase();
  177.         }
  179.         // 之前定义的辅助方法
  180.         private void AddFilesToContent(StringBuilder content, string directory, string outputDirectory)
  181.         {
  182.             if (!Directory.Exists(directory))
  183.             {
  184.                 return;
  185.             }
  187.             foreach (var file in Directory.GetFiles(directory, "*.html"))
  188.             {
  189.                 var itemName = Path.GetFileNameWithoutExtension(file);
  190.                 var relativePath = file.Substring(outputDirectory.Length + 1);
  191.                 content.AppendLine($@"
  192.                 <LI> <OBJECT type=""text/sitemap"">
  193.                     <param name=""Name"" value=""{itemName}"">
  194.                     <param name=""Local"" value=""{relativePath}"">
  195.                     </OBJECT>");
  196.             }
  197.         }
  198.     }
复制代码

  • 调用
  1. internal class Program
  2. {
  4.     // 查找HHC编译器
  5.     private static string FindHhcCompiler()
  6.     {
  7.         // 检查常见位置
  8.         string[] possiblePaths = new[]
  9.         {
  10.                 @"C:\Program Files (x86)\HTML Help Workshop\hhc.exe",
  11.                 @"C:\Program Files\HTML Help Workshop\hhc.exe"
  12.             };
  14.         foreach (string path in possiblePaths)
  15.         {
  16.             if (File.Exists(path))
  17.             {
  18.                 return path;
  19.             }
  20.         }
  22.         // 检查PATH环境变量
  23.         string pathEnv = Environment.GetEnvironmentVariable("PATH");
  24.         if (!string.IsNullOrEmpty(pathEnv))
  25.         {
  26.             string[] paths = pathEnv.Split(Path.PathSeparator);
  27.             foreach (string path in paths)
  28.             {
  29.                 string fullPath = Path.Combine(path.Trim(), "hhc.exe");
  30.                 if (File.Exists(fullPath))
  31.                 {
  32.                     return fullPath;
  33.                 }
  34.             }
  35.         }
  37.         return null;
  38.     }
  40.     private static void Main(string[] args)
  41.     {
  42.         Console.WriteLine("Oracle Database CHM Documentation Generator");
  43.         Console.WriteLine("==========================================");
  45.         try
  46.         {
  47.             //数据库列表，自行添加
  48.             List<string> schemaList = new List<string>
  49.            {
  50.            };
  52.             // 配置参数         
  53.             var baseDir = Path.Combine(Directory.GetCurrentDirectory(), "OracleDocs");
  56.             var hhcPath = FindHhcCompiler();
  57.             var outputDir = Path.Combine(baseDir, "OracleDocs");
  58.             var dic = new Dictionary<string, Tuple<List<TableInfo>, List<ViewInfo>, List<ProcedureInfo>>>();
  59.             foreach (var item in schemaList)
  60.             {
  61.                 var projectName = $"TH_{item}";
  62.                 var connectionString = $"";//自行添加
  63.                 // 创建服务实例
  64.                 using (var metadataService = new OracleMetadataService(connectionString))
  65.                 {
  66.                     Console.WriteLine("Fetching database metadata...");
  68.                     // 获取元数据
  69.                     var tables = metadataService.GetTables();
  70.                     var views = metadataService.GetViews(projectName);
  71.                     var procedures = metadataService.GetProcedures();
  72.                     dic.Add(projectName, Tuple.Create(tables, views, procedures));
  74.                     Console.WriteLine($"Found {tables.Count} tables, {views.Count} views, {procedures.Count} procedures/functions");
  75.                 }
  76.             }
  78.             // 生成HTML文档
  79.             var htmlGenerator = new HtmlGeneratorService(outputDir);
  80.             Console.WriteLine("Generating HTML files...");
  81.             htmlGenerator.GenerateHtmlFiles(dic);
  83.             // 编译CHM
  84.             var chmCompiler = new ChmCompiler(hhcPath);
  85.             Console.WriteLine("Creating CHM project files...");
  86.             chmCompiler.CreateHhpFile(outputDir, "OracleDocs");
  88.             Console.WriteLine("Compiling CHM file...");
  89.             var hhpFilePath = Path.Combine(outputDir, $"TH.hhp");
  90.             var chmFilePath = Path.Combine(outputDir, $"TH.chm");
  92.             //var result = Task.Run(async () => await chmCompiler.RunProcessAsync(hhpFilePath)).Result;
  93.             if (chmCompiler.Compile(hhpFilePath, chmFilePath))
  94.             //if (result == 0)
  95.             {
  96.                 Console.WriteLine($"Successfully generated CHM file: {chmFilePath}");
  97.             }
  98.             else
  99.             {
  100.                 Console.WriteLine("CHM compilation failed.");
  101.             }
  102.         }
  103.         catch (Exception ex)
  104.         {
  105.             Console.WriteLine($"Error: {ex.Message}");
  106.             if (ex.InnerException != null)
  107.             {
  108.                 Console.WriteLine($"Inner exception: {ex.InnerException.Message}");
  109.             }
  110.         }
  112.         Console.WriteLine("Press any key to exit...");
  113.         Console.ReadKey();
  114.     }
  115. }
复制代码
来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

使用道具 举报
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
稼布欤
2025-6-28 09:38:20

0

粉丝关注

10

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫