使用 Limyee 电商平台开发基于代码的自定义项时,正确管理异常和处理日志记录非常重要。Limyee 电商平台提供服务,以实现有效的用户通知、异常记录和记录平常执行日志。
为什么我需要以特定方式处理异常/日志记录?
插件是 .NET 类,可以抛出 .NET 异常并识别异常问题,并且有许多处理日志记录的解决方案。Limyee 电商平台支持集成异常处理和进程日志记录,为管理员和平台会员提供一致的错误和进程处理体验。
异常呈现
当异常从插件冒泡给用户时,无论是通过UI渲染还是在处理REST请求时,Limyee电商平台都会解释异常,且向访问用户返回错误响应。为了防止信息泄露安全漏洞,默认情况下,异常将替换为 UI 或 REST 响应的一般错误消息。
若要启用返回自定义消息,抛出的异常必须实现 IUserRenderableException。此接口可以应用于自定义异常实现,以向 Limyee 电商平台标识该异常可以向用户提供适当、安全且有建设性的消息。该接口定义了一个会员 GetUserRenderableMessage,它返回一个字符串。此方法的结果将通过 UI 返回并显示给用户,或放置在 REST 响应的 Errors 集合中(取决于 API 和间接访问插件的方式)。
异常日志记录
某些异常是由用户错误引起的,例如,在预期数字的位置输入“abc”。其他例外情况可能会因为配置问题。日志记录可以检查和更正已发生的问题。
Limyee 电商平台包括一个异常日志(管理 > 监测 > 异常),并且还可以通过在抛出的异常上实现 ILoggableException 来记录自定义异常。任何冒泡到最终用户的异常都会由 Limyee 电商平台进行审查,以查看它是否实现了ILoggableException。如果是这样,则将异常添加到平台的异常日志中。
ILoggableException 只需要实现一个成员:Category。Category 返回的字符串在异常日志 UI 中用于对日志的异常列表进行分类和筛选。
进程日志记录
有时,后台进程记录非异常进程信息也很有用。在这种情况下,插件可以使用事件日志 API。事件日志 API 使插件能够将日志记录数据写入到 Limyee 电商平台事件日志(管理 > 监测 > 事件)。若要写入事件日志条目,请使用 Write 方法。