原创力文档- 1、本文档共21页，可阅读全部内容。
- 2、原创力文档（book118）网站文档一经付费（服务费），不意味着购买了该文档的版权，仅供个人/单位学习、研究之用，不得用于商业用途，未经授权，严禁复制、发行、汇编、翻译或者网络传播等，侵权必究。
- 3、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己接受本站规则且自行承担风险，本站不退款、不进行额外附加服务；查看《如何避免下载的几个坑》。如果您已付费下载过本站文档，您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等，请点击“版权申诉”（推荐），也可以打举报电话：400-050-0827(电话支持时间：9:00-18:30)。
- 5、该文档为VIP文档，如果想要下载，成为VIP会员后，下载免费。
- 6、成为VIP后，下载本文档将扣除1次下载权益。下载后，不支持退款、换文档。如有疑问请联系我们。
- 7、成为VIP后，您将拥有八大权益，权益包括：VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 8、VIP文档为合作方或网友上传，每下载1次， 网站将根据用户上传文档的质量评分、类型等，对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
XXX产品
总体设计说明书
作者：
版本号：
时间：
版权所有：用友软件股份有限公司
日志系统使用规范
目 录
TOC \o 1-3 1.介绍 2
2.API祥解 2
2.1 普通日志API 2
2.2动态日志API 4
2.3 Debug 6
2.4 日志配置API 7
2.5 MDC与NDC概念 7
3.配置 8
3.1 系统配置 8
3.2 模块日志的配置 8
3.2.1 模块名 9
3.2.2 日志级别 10
3.2.3 日志格式设置 11
3.2.4 日志输出 11
3.1.5 日志分类和XML输出 13
3.1.5.1 XML格式规范 13
4.日志规范 15
4.1日志API的选择 15
4.2 日志级别的选择 15
4.3 日志信息选择 15
4.5日志输出文件 16
4.6 多线程环境 16
4.4 错误日志输出 17
4.5 代码日志规范 17
1 引言 3
1.1 编写目的 3
1.2 背景 3
1.3 定义 3
1.4 参考资料 3
2 总体结构设计 3
2.1 需求规定 3
2.2 总体解决方案 3
2.2.1结构图及说明 3
2.2.2核心技术 3
2.3 总体应用结构 3
2.3.1模块划分与命名 3
2.3.2模块接口关系 3
2.3.3模块功能范围 3
2.3.4运行模块组合 3
2.4 软件分布设计 3
2.4.1层次结构设计规范 3
2.4.2代码分布 3
2.4.3数据库分布 3
2.5 开发环境 3
2.6 运行环境支持 3
2.7 总体界面风格与系统管理设计 3
2.8 网络安全及软件保护 3
2.9 技术规范与技术方案 3
2.9.1界面规范 3
2.9.1 命名规范 3
2.9.1数据库设计规范 3
2.9.1数据库建模规范 3
3 总体功能设计 3
3.1 概念模型/功能结构图 3
3.2 功能设计 3
3.2.1系统参数 3
3.2.2模块功能清单 3
3.2.3业务组件清单 3
3.3 数据库概要设计 3
3.3.1数据类型 3
3.3.2数据库表清单 3
3.3.3 ER图 3
3.3.4数据库结构 3
3.3.5数据库操作 3
3.4 接口详细设计 3
4 公共平台设计 3
3.1 基类 3
3.2 公共组件 3
3.3 平台 3
5 系统数据结构设计 3
5.1 外部文件 3
5.1.1外部文件1（标识符）结构 3
5.1.1外部文件2（标识符）结构 3
5.2 系统数据库设计 3
5.2.1 XXXX（标识符）数据库设计 3
5.3 全局数据 3
6 容错处理 3
7.1 出错信息 3
7.2 补救措施 3
7.3 系统维护设计 3
7 安装 3
8 测试部分 3
8.1 测试指南 3
8.2 成策略 3
8.3 特殊考虑 3
附录 3
介绍
日志系统主要解决运行时刻系统的状态跟踪,为潜在的系统维护和分析提供信息收集的手段。本文档主要介绍NCV5日志API的使用、概念、配置和使用规范。
NCV5的日志系统以模块为中心，可以按照每个模块配置该模块所需要输出的信息量、日志级别、输出位置，同时考虑到了模块的父子关系，通过模块的父子关系，可以精确调控各个层次的信息输出，如关闭模块的日志输出、调整模块的日志信息等。
2.API详解
日志系统的API较为简单，大部分程序员只要关注这一节的内容即可。日志系统的API根据需求主要分为三大部分，第一个部分为日志API,第二个部分为Debug的API，主要帮助程序的调试，第三个部分为日志配置，主要用于系统的自动配置。
2.1 普通日志API
普通的日志交互主要的类为Log,通过该类，通过该API日志时日志系统使用的模块不会动态变化，普通日志使用的API在应用程序编译时刻就已经确定。
下面是一个普通的日志API使用的例子：
package nc.bs.demo.logging;
import nc.bs.logging.Log;
public class HelloWorld {
private static final Log log = Log.getInstance(HelloWorld.class);
public static void main(String args[]) {
log.debug(Hello,World);
}
}
HelloWorld定义了一个Log对象常量，他的模块名为HelloWorld的类名，即nc.bs.demo.logging.HelloWorld,运行该程序，如果输出设定为XML那么输出为：
Pub Thd=main Mod=nc.bs.demo.logging.Hel
文档评论（0）