{"id":17543634,"url":"https://github.com/xkcoding/magic-starter-log-demo","last_synced_at":"2025-03-29T05:34:05.318Z","repository":{"id":102484856,"uuid":"210651390","full_name":"xkcoding/magic-starter-log-demo","owner":"xkcoding","description":"magic-starter-log 日志模块集成 demo","archived":false,"fork":false,"pushed_at":"2019-09-25T02:18:49.000Z","size":3116,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-03T15:55:39.866Z","etag":null,"topics":["demo","logger","magic-starter","spring-boot-2","spring-boot-starter","xkcoding"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xkcoding.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-24T16:41:00.000Z","updated_at":"2019-10-31T09:32:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"7ec949dd-e0cb-4dda-8da2-feda10c43fe5","html_url":"https://github.com/xkcoding/magic-starter-log-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xkcoding%2Fmagic-starter-log-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xkcoding%2Fmagic-starter-log-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xkcoding%2Fmagic-starter-log-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xkcoding%2Fmagic-starter-log-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xkcoding","download_url":"https://codeload.github.com/xkcoding/magic-starter-log-demo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246145013,"owners_count":20730494,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["demo","logger","magic-starter","spring-boot-2","spring-boot-starter","xkcoding"],"created_at":"2024-10-21T00:25:04.149Z","updated_at":"2025-03-29T05:34:05.290Z","avatar_url":"https://github.com/xkcoding.png","language":"Java","readme":"# magic-starter-log-demo\n\n\u003e 演示日志模块的使用\n\n## 使用方法\n\n### 1. 三种日志如何触发\n\n- 操作日志\n\n\u003e 在需要记录操作日志的方法上添加注解，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/be5a26decb6339d0e0daddf5f24ce6ab63e234e9/src/main/java/com/xkcoding/magicstarterlogdemo/controller/TestController.java#L25\n\n```java\n@OperateLog(\"操作日志内容\")\n```\n\n- 自定义日志\n\n\u003e 例子：https://github.com/xkcoding/magic-starter-log-demo/blob/be5a26decb6339d0e0daddf5f24ce6ab63e234e9/src/main/java/com/xkcoding/magicstarterlogdemo/controller/TestController.java#L28\n\n```java\n@Autowired\nprivate MagicLogger magicLogger;\n\nmagicLogger.warn(\"日志前缀\", \"日志内容\");\nmagicLogger.debug(\"日志前缀\", \"日志内容\");\nmagicLogger.info(\"日志前缀\", \"日志内容\");\nmagicLogger.error(\"日志前缀\", \"日志内容\");\n```\n\n- 错误日志\n\n\u003e 建议在全局拦截的地方触发，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/be5a26decb6339d0e0daddf5f24ce6ab63e234e9/src/main/java/com/xkcoding/magicstarterlogdemo/handler/GlobalExceptionHandler.java#L23\n\n```java\nLogEventPublisher.publishErrorLogEvent(exception);\n```\n\n### 2. 三种日志如何处理\n\n\u003e 1. 继承 LogHandler 重写对应日志类型处理方法即可，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/master/src/main/java/com/xkcoding/magicstarterlogdemo/config/support/DemoLogHandler.java\n\u003e 2. 交给 Spring 容器管理，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/master/src/main/java/com/xkcoding/magicstarterlogdemo/config/LogConfig.java\n\n```java\n/**\n * \u003cp\u003e\n * 日志执行逻辑\n * \u003c/p\u003e\n *\n * @author yangkai.shen\n * @date Created in 2019/9/24 19:43\n */\n@Slf4j\npublic class DemoLogHandler implements LogHandler {\n    @Override\n    public void handleOperateLog(OperateLogModel logModel) {\n        log.info(\"【OperateLogModel】= {}\", JSONUtil.toJsonStr(logModel));\n    }\n\n    @Override\n    public void handleCustomLog(CustomLogModel logModel) {\n        log.info(\"【CustomLogModel】= {}\", JSONUtil.toJsonStr(logModel));\n    }\n\n    @Override\n    public void handleErrorLog(ErrorLogModel logModel) {\n        log.info(\"【ErrorLogModel】= {}\", JSONUtil.toJsonStr(logModel));\n    }\n}\n```\n\n### 3. web请求/响应日志\n\n```yaml\nmagic:\n  log:\n    request:\n      enabled: true\n```\n\n### 4. 通用日志配置文件\n\n```yaml\nspring:\n  application:\n    name: magic-starter-log-demo\nlogging:\n  config: classpath:com/xkcoding/magic/log/logback/logback-spring.xml\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxkcoding%2Fmagic-starter-log-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxkcoding%2Fmagic-starter-log-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxkcoding%2Fmagic-starter-log-demo/lists"}