一种显示软件错误码信息的方法及系统与流程

本发明涉及计算机技术领域，特别是涉及一种显示软件错误码信息的方法及系统。

背景技术：

随着计算机的飞速发展，计算机软件程序也被广泛应用。在运行某个软件程序时，当发生功能性错误，软件程序会给出一个数值及简单的错误类型，该数值作为错误代码的唯一标识，可以用于区分不同的错误类型。

然而，错误的数值是为了给计算机程序识别的，业务层通过识别不同的数值确定软件程序发生错误类型及原因，并根据不同的错误类型执行不同的逻辑操作。可是简单的错误数值及错误类型，对于操作人员来说不容易理解，不便于查找错误的原因，而且对于不同的软件运行环境及不同的运行地点，需要编写不同的文件去存储错误数值及错误类型，增加开发人员的工作时间，影响工作效率。

技术实现要素：

本发明主要解决的技术问题是提供一种显示软件错误码信息的方法及系统，能够在软件运行的不同环境下，显示详细的错误码及错误码对应的错误信息，进而提高开发人员的工作效率。

为解决上述技术问题，本发明采用的一个技术方案是：提供一种显示软件错误码信息的方法，所述方法包括：生成用来定义错误码及错误码对应的错误信息的配置文件；根据配置文件自动生成本地化语言文件；根据本地化语言文件自动生成与软件的开发工具所对应的错误码提示文件；编译软件的开发工具，以得到包含错误码提示文件的软件程序；运行软件程序，当软件程序发生运行错误时，根据软件程序的错误码提示文件，显示错误码及错误码对应的错误信息，且显示的错误码对应的错误信息匹配软件的运行地点和运行环境。

其中，生成用来定义错误码及错误码对应的错误信息的配置文件，包括：将错误码按不同类型进行分组管理，且每一个错误码都对应唯一标识；错误码与错误信息一一对应。

其中，根据配置文件自动生成本地化语言文件，包括：将配置文件翻译成软件对应的运行环境的语言，并以运行环境的语言的国际标准编码和国别码对配置文件进行命名；生成一个默认的本地化语言文件，默认的本地化语言文件可以在所有语言环境下运行。

其中，所述方法还包括：根据配置文件自动生成错误码的说明文档；编译软件的开发工具，以得到包含错误码的说明文档的软件程序；运行软件程序，在软件程序的说明文档中查看错误码的说明文档。

其中，配置文件为XML文件。

为解决上述技术问题，本发明采用的另一个技术方案是：提供一种显示软件错误码信息的系统，所述系统包括：配置模块：用于生成用来定义错误码及错误码对应的错误信息的配置文件；翻译模块：用于根据配置文件自动生成本地化语言文件；编码模块：用于根据本地化语言文件自动生成与软件的开发工具所对应的错误码提示文件；第一编译模块：用于编译软件的开发工具，以得到包含错误码提示文件的软件程序。第一运行模块：用于运行软件程序，当软件程序发生运行错误时，根据软件程序的错误码提示文件，显示错误码及错误码对应的错误信息，且显示的错误码对应的错误信息匹配软件的运行地点和运行环境。

其中，配置模块具体用于：将错误码按不同类型进行分组管理，且每一个错误码都对应唯一标识；错误码与错误信息一一对应。

其中，翻译模块具体用于：将配置文件翻译成软件对应的运行环境的语言，并以运行环境的语言的国际标准编码和国别码对配置文件进行命名；生成一个默认的本地化语言文件，默认的本地化语言文件可以在所有语言环境下运行。

其中，系统还包括：生成模块：用于根据配置文件自动生成错误码的说明文档；第二编译模块：用于编译软件的开发工具，以得到包含错误码的说明文档的软件程序；第二运行模块：运行软件程序，在软件程序的说明文档中查看错误码的说明文档。

其中，配置文件为XML文件。

本发明的有益效果是：根据生成的用于定义错误码及错误码对应的错误信息的配置文件，可以自动生成本地化语言文件及与软件的开发工具所对应的错误码提示文件，进而得到包含错误码提示文件的软件程序，当软件程序发生运行错误时，根据软件程序的错误码提示文件，显示错误码及错误码对应的错误信息，通过上述方式，能够在软件运行的不同环境下，显示详细的错误码及错误码对应的错误信息，进而提高开发人员的工作效率。

附图说明

图1是本发明显示软件错误码信息方法第一实施例的流程示意图；

图2是本发明显示软件错误码信息方法第二实施例的流程示意图；

图3是本发明显示软件错误码信息方法第三实施例的流程示意图；

图4是本发明显示软件错误码信息方法第四实施例的流程示意图；

图5是本发明显示软件错误码信息系统第一实施例的流程示意图；

图6是本发明显示软件错误码信息系统第二实施例的流程示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅是本发明的一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

请参阅图1，图1是本发明显示软件错误码信息方法第一实施例的流程示意图。需注意的是，若有实质上相同的结果，本发明的方法并不以图1所示的流程顺序为限。如图1所示，该方法包括如下步骤：

S10：生成用来定义错误码及错误码对应的错误信息的配置文件。

其中，错误码包括一个数值及该数值对应的错误类型，该数值用于区分不同的错误类型。在运行某个软件程序时，当软件程序发生功能性错误时，软件会给出一个数值及该数值对应的错误类型。一般情况下，错误码中的数值是为了给计算机程序识别的，如业务层可以根据不同的数值执行不同的逻辑应用，因此该数值必须是唯一的。而错误类型可以供操作人员使用，操作人员可以根据不同的错误类型去判断或分析软件程序出错的原因。例如：

111SQLSTATE：HY000(SERVER_STORE_NOT_PERMISSION)，

//111为错误数值，SERVER_STORE_NOT_PERMISSION为错误类型。

由于错误码中包含的数值及错误类型对于操作人员来说不太容易理解，因此，在本实施例的配置文件中，除了定义错误码外，还进一步定义了错误码对应的错误信息。其中，错误信息可以包括简短描述及详细描述。简短描述对应于系统提供的错误类型，而详细描述用于详细说明错误发生的可能的原因。例如：错误码“111”对应的简短描述为“无法创建文件”，详细描述为“因为权限的原因，可能导致不能创建文件”。开发人员通过手动编写或由工具自动生成相应的配置文件，进而定义所有错误码及错误码对应的错误信息，通过修改或添加配置文件的内容，开发人员可以对所有错误码进行管理和维护。在本实施例中，可以将配置文件以可扩展标记语言(Extensible Markup Language，XML)文件的方式进行存储并使用，在其它应用场景中，也可以使用其他可以将错误码及错误码对应的错误信息进行分类存储的文件格式作为配置文件。

S11：根据配置文件自动生成本地化语言文件。

由于操作人员来自不同的国家，而编写配置文件时，可能只用了其中某一种语言，为了能够让不同语种的人都能看懂错误信息中的描述内容，需要在不同的语种环境下显示对应的错误描述信息，如简体中文环境下，显示简体中文的错误描述信息，法语环境下，显示法语的错误描述信息，因此，需要根据配置文件自动生成本地化语言文件。

S12：根据本地化语言文件自动生成与软件的开发工具所对应的错误码提示文件。

由于不同的软件开发工具对应不同的生成代码，而不同的代码对应不同的语法规则，因此，在本发明中，为了能够在软件对应的所有开发环境中，都可以使用步骤S11生成的本地化语言文件，需要设计一个代码方案，即针对不同的开发语言自动生成不同的错误码提示文件，以便程序运行时，可以通过读取错误码提示文件显示错误码对应的错误信息。例如，在C/C++编程环境中，使用C语言对应的语法及规则，自动生成与C语言对应的错误码提示文件，而在Java编程环境中，使用Java语言对应的语法及规则，自动生成与Java语言对应的错误码提示文件。

以Java程序为例，下面举例说明在Java程序中，生成对应的错误码提示文件的方法：

S13：编译软件的开发工具，以得到包含错误码提示文件的软件程序。

S14：运行软件程序，当软件程序发生运行错误时，根据软件程序的错误码提示文件，显示错误码及错误码对应的错误信息，且显示的错误码对应的错误信息匹配软件的运行地点和运行环境。

在软件运行过程中，当运行程序发生错误时，系统访问软件程序中的错误码提示文件，通过查找文件中对应的错误码，找到错误码对应的错误信息，并将错误码及错误码对应的错误信息在程序运行的终端界面进行显示，为操作人员提供参考。针对不同软件的运行地点和运行环境，显示不同的语言的错误信息。如：在中文操作系统上，显示“111_无法创建文件_因为权限的原因，可能导致不能创建文件”，英文操作系统上，显示“111_NOT_PERMISSION_not permission”。

通过上述方法，能够在软件运行的不同环境下，显示不同语言的详细错误码及错误码对应的错误信息，提高工作效率。

参考图2，图2是本发明显示软件错误码信息方法第二实施例的流程示意图，步骤S10进一步包括以下步骤：

S201：将错误码按不同类型进行分组管理，且每一个错误码都对应唯一标识。

S202：错误码与错误信息一一对应。

为了便于开发人员对所有错误码及错误码对应的错误信息进行管理和维护，需要对所有错误码按不同类型进行分组管理。例如，某一个错误码的数值属于A类，在A类的基础上，还可以细分为A1、A2、A3……等，在A1类的基础上，还可以划分为A11、A12……等，依此类推，可以进行多次划分，但是，在每个同级划分的数值中，必须确保所有数值是唯一的，不能与其他数值相同，如：A_A1_A11_1、A_A1_A11_2或A_A1_A12_1、A_A1_A12_2等。错误码中的数值与错误类型必须一一对应。

在其中一个应用场景中，以XML文件为例，生成用来定义错误码及错误码对应的错误信息的配置文件。

顶级节点errors：用于描述配置的开始；

module节点：用于描述一种类型的所有错误码，该类型的所有错误数值及错误类型定义必须都存放于该module下；

module节点的属性id:错误码对应的数值，在其父节点下该id需要是唯一的；

module节点的属性code:错误码对应的错误类型，在其父节点下该code需要是唯一的；

error：描述一个具体的错误信息；

error节点的属性id：错误码对应的数值，必须是全局唯一的数值；

error节点的属性code：错误码对应的错误类型，必须是全局唯一的；

error子节点msg的内容：简短的默认的错误描述信息；

error子节点desc的内容：详细的错误发生的可能原因；

其中，module节点及error节点下都可以有多个子节点，即module节点下可以包含多个module子节点及error子节点，而error节点下也可以包含多个error子节点及module子节点，以此将所有错误码进行分类存储及管理。

通过上述的一个应用场景可以得到以下错误码及错误码对应的错误信息，使得错误码与错误信息一一对应：

111_SERVER_STORE_NOT_PERMISSION：“无法创建文件”，“因为权限的原因，可能导致不能创建文件”；

112_SERVER_STORE_NOT_FOUND：“没有找到文件”，“可能因为没有读权限，也可能是因为没有此文件，因此无法找到文件”

通过上述方式，可以将所有错误码进行分类存储，便于操作人员对配置文件中所有的错误码信息进行查找及维护，提高工作效率。

参考图3，图3是本发明显示软件错误码信息方法第三实施例的流程示意图。步骤S11还包括以下步骤：

S301：将配置文件翻译成软件对应的运行环境的语言，并以运行环境的语言的国际标准编码和国别码对配置文件进行命名。

S302：生成一个默认的本地化语言文件，默认的本地化语言文件可以在所有语言环境下运行。

在本实施例中，为了能让不同语种的人都能看懂配置文件中错误码对应的错误描述信息，需要将配置文件翻译成不同国家的语言，例如，在简体中文的环境下，显示简体中文描述的错误信息；在英语环境下，显示英文描述的错误信息。在实施过程中，通过翻译软件将原有的配置文件，翻译成不同国家的语言，并以国际标准编码和国别码对配置文件进行命名，便于其它程序查找对应的配置文件。例如：简体中文命名为：zh_CN.properties，英文文件命名为：en_US.properties。

在其中一个应用场景中，为了便于开发程序读取错误码及错误码对应的错误描述，可以将存储文件中的错误描述以字符串的类型显示出来，例如：

在zh_CN.properties文件中，显示某一个错误描述：

SERVER_STORE_NOT_PERMISSION＝％s没有权限％s

SERVER_STORE_NOT_FOUND＝没有找到文件％s

在en_US.properties文件中，显示某一个错误描述：

SERVER_STORE_NOT_PERMISSION＝％snot permission％s

SERVER_STORE_NOT_FOUND＝not found％s

在另一实施例中，还可以生成一个默认的公共配置文件作为本地化语言文件，当软件运行时，没有找到与其语种对应的本地化文件时，可以使用该默认文件作为配置文件，并从该文件中获取错误描述信息。该文件命名为“default.properties”。例如：程序运行在法文系统下，而本地文件中没有法文对应的本地化文件，程序运行时可以使用默认文件，如果后序程序新增了法文对应的本地化文件，则在下次运行程序时，程序自动选择法文对应的本地化文件，并从该文件中读取相应的描述信息，软件程序无需做任何修改。为了方便在软件开发过程中，软件程序能够准确的识别配置文件中的错误码及错误码对应的错误信息，在生成本地化文件时，可以将每一个错误描述信息生成一行代码，且该行代码中，该错误描述信息所对应的标识符是唯一。

例如：SERVER_STORE_NOT_PERMISSION＝％s not permission％s

通过上述方法，可以在软件开发的任何环境下，生成对应的本地化语言文件，进而生成对应的错误码提示文件。当需要使用的本地化语言文件不存在时，也可以使用默认文件进行操作。

图4是本发明显示软件错误码信息方法第四实施例的流程示意图，如图4所示，该方法还包括以下步骤：

S40：根据配置文件自动生成错误码的说明文档。

S41：编译软件的开发工具，以得到包含错误码的说明文档的软件程序。

S42：运行软件程序，在软件程序的说明文档中查看错误码的说明文档。

为了能够让用户在程序使用过程中，查询所有错误码的错误数值及错误信息，可以在软件的说明文档中添加一个错误码的说明文档，用于对生成的各类错误进行详细描述，便于用户参考及查看。在编译过程中，通过读取配置文件，生成对应的说明文档，该文档包括：错误码编号、错误码类型、错误信息及详细的错误解释。如表1所示：

表1

在本实施例中，可以使用扩展样式表转换语言(Extensible Stylesheet Language Transformations，XSLT)来生成错误的信息，也可以使用其它的生成方式生成对应的错误信息，在此不做任何限制。

通过上述方法，操作人员可以很方便的查看软件程序中的说明文档，进而快速查询错误码所对应的错误信息及详细解释，提高了工作效率。

请参阅图5，图5是本发明显示软件错误码信息系统第一实施例的流程示意图。本实施例中，该系统包括：配置模块51、翻译模块52、编码模块53、第一编译模块54及第一运行模块55。

配置模块51：用于生成用来定义错误码及错误码对应的错误信息的配置文件；

翻译模块52：用于根据配置文件自动生成本地化语言文件；

编码模块53：用于根据本地化语言文件自动生成与软件的开发工具所对应的错误码提示文件；

第一编译模块54：用于编译软件的开发工具，以得到包含错误码提示文件的软件程序。

第一运行模块55：用于运行软件程序，当软件程序发生运行错误时，根据软件程序的错误码提示文件，显示错误码及错误码对应的错误信息，且显示的错误码对应的错误信息匹配软件的运行地点和运行环境。

其中，配置模块51具体用于将错误码按不同类型进行分组管理，且每一个错误码都对应唯一标识；错误码与错误信息一一对应。

其中，翻译模块52具体用于将配置文件翻译成软件对应的运行环境的语言，并以运行环境的语言的国际标准编码和国别码对配置文件进行命名；生成一个默认的本地化语言文件，默认的本地化语言文件可以在所有语言环境下运行。

其中，配置文件为XML文件。

图6是本发明显示软件错误码信息系统第二实施例的流程示意图，该系统还包括：生成模块61、第二编译模块62及第二运行模块63。

生成模块61：用于根据配置文件自动生成错误码的说明文档；

第二编译模块62：用于编译软件的开发工具，以得到包含错误码的说明文档的软件程序；

第二运行模块63：运行软件程序，在软件程序的说明文档中查看错误码的说明文档。

本实施例中的各个模块及单元可分别执行上述方法实施例中对应的步骤，故在此不对各模块进行赘述，详细请参阅以上对应步骤的说明。

在本发明所提供的几个实施方式中，应该理解到，所揭露的系统，和方法，可以通过其它的方式实现。例如，所述模块或单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个系统，或一些特征可以忽略，或不执行。上述集成的单元既可以采用硬件的形式实现，也可以采用软件功能单元的形式实现。

以上所述仅为本发明的实施方式，并非因此限制本发明的专利范围，凡是利用本发明说明书及附图内容所作的等效结构或等效流程变换，或直接或间接运用在其他相关的技术领域，均同理包括在本发明的专利保护范围内。