1 Star 1 Fork 3

Ym/LogDog

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
Ym v2.5.6 b680c10 2个月前
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

LogDog(日志狗)

介绍

LogDog 是一个开源的 Java 日志框架,它提供了一种简单、高效的方式来管理应用程序的日志。它的特点如下:

  1. 简单易用:LogDog 提供了一个简单的 API,可以使用它来记录日志,而不需要写复杂的代码。

  2. 多种输出方式:LogDog 支持多种输出方式,包括控制台输出、log文件输出、logcat 输出等。

  3. 日志级别控制:LogDog 提供了多种日志级别控制,包括 DEBUG、INFO、WARN、ERROR等。

  4. 可扩展性:开发人员可以通过封装进行扩展,开发者可以自定义输出方式和日志格式等。

  5. 性能优化:LogDog 使用异步方式进行日志处理,可以提高日志记录的性能。

总的来说,LogDog 是一个功能强大、易用性高、性能优秀的 Android日志框架。

LogDog优点

  1. 打印的格式

日志格式采用同一时刻打印,如果超出打印限制则分多次打印,同一时刻打印和较少的日志分割符便用开发人员复制日志信息,而不会因为复制日志造成复制了多余的日志分割符从而不利于开发。


    ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━start━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
         //当前线程信息
    ┣┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┫
         // 当前方法栈信息
    ┣┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┫
        //需打印的信息
    ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━end━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛


  1. 日志信息

除了提供基本的打印信息,还提供了打印当前线程信息,当前方法栈信息: 大概就是四行三块; 第一行是日志开始分割符 注明start; 第一块是线程信息 需要开发人员自行设置开启; 第二行、第三行都是日志的中部信息间隔符; 第二块是当前方法栈信息点击方法内的信息就可直接跳转对应的行数,按顺序打印,所以最后一个方法其实就是打印函数调用的方法; 第三块是需要打印的信息; 第四行是一条日志结束的分割符号。

    ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━start━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
        currentThread: main
    ┣┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┫
        com.ym521.simp.MainActivity.setLog(MainActivity:23)
            com.ym521.simp.MainActivity.initView(MainActivity:37)
                com.ym521.simp.MainActivity.initConfig(MainActivity:28)
    ┣┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┫
    开始测试第一例
    ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━end━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

  1. LogDog的使用便利

LogDog使用koltin开发,在对外使用的方法,都采用静态函数(方法):

  LogDog.debug(tag, msg) //对应 Log.d 

LogDog.info(tag, msg) //对应 Log.i

LogDog.warn(tag, msg) //对应 Log.w

LogDog.error(tag, msg)//对应 Log.e

如上,所有打印函数是可以字节类名调用的,前提是LogDog已实现初始化。

  1. 参数优化

其他Log框架对打印参数都做了限定,LogDog不在限制开发人员打印的参数进行限制,可以是对象、基本类型、数组等都可以;总是在打印 引用类型时会使用Json引擎进行Json转换,JsonEngine LogDog只提供相同的接口,方便开发人员对其自定义实现,采用何种Json框架由开发人员自己决定;当然 这样也就产生了Json引擎是初始化时必要的参数。

  1. 日志文件输出

Android 原生Log未提供日志文件的写入,LogDog提供了一套以日期中的天为单位的日志文件写入引擎;因为是以天为日志文件单位,所有一天之内的日志都只会在一个文件内;为了避免 过多的权限申请,所以日志文件采用APP内部私有空间,但是为了方便日志文件的外部提取,LogDog也提供APP外部私有空间的存储,只需要在初始化LogDog 进行配置开启就可以了,因为都是私有空间所以都 不用权限申请。

  1. 日志文件的内容加密

有时日志内容涉及用户和系统、APP的涉密信息,所以需要对日志文件内的内容进行加密,避免在用户提取日志文件时造成信息泄密威胁运行的系统安全,所以日志文件加密很重要,当然LogDog也提供了日志文件加密 只需要在初始化LogDog 进行开启AES和配置Key就可以了,并且加密只加密 打印数据部分对于TAG、时间戳 log等级不进行加密,由于加密是采用逐条Log加密的所以解密也需要逐条Log解密; 这个问题后期版本会采用整体加密或者其他加密形式优化这个问题。

安装教程

  1. 添加远程仓库

maven { url 'https://jitpack.io' }

  1. 添加依赖

最新版本


dependencies {
	        implementation 'com.gitee.ym521:logdog:LatestVersion'
	}

使用说明

个人建议最好在自定义的Application的onCreate()中先调用;记得在AndroidManifest.xml 设置自定义的Application!!!


class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        //这里使用的是 Google开源 Gson 也可以使用其他Json 框架 如:阿里的FastJson
        val gson = Gson()

        //开发人员自行实现对象转json字符串
        LogDog.Builder()
            .logWriteLogFileEnable(true) //是否开启写入日志文件
            .logShowMethodEnable(true) //是否开启显示方法栈信息 默认打印两个方法信息
            .logShowThreadInfoEnable(true) //是否打印当前线程信息
            .install(this, object : IJsonEngine {
                override fun toJSON(obj: Any): String {
                    return gson.toJson(obj)
                }
            })
    }
}



public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        //这里使用的是 Google开源 Gson 也可以使用其他Json 框架 如:阿里的FastJson
        Gson gson = new Gson();
        new LogDog.Builder()
                .logWriteLogFileEnable(true) //是否开启写入日志文件
                .logShowMethodEnable(true) //是否开启显示方法栈信息 默认打印两个方法信息
                .logShowThreadInfoEnable(true) //是否打印当前线程信息
                .install(this, new IJsonEngine() {
                    @NonNull
                    @Override
                    public String toJSON(Object obj) {
                        return gson.toJson(obj);
                    }
                });
    }
}


LogDog功能使用

  1. LogDog 配置说明
   LogDog.builder
    .logFilter() //日志过滤 默认全部打印;例如过滤debug、info: logFilter(LogPriority.DEBUG, LogPriority.INFO) 
    .extraOffset(0) //自定义方法/函数栈的打印零点的额外补充调整 范围[-3 ,5]   
    .logShowMethodEnable(false) //是否打印方法信息和打印多少个方法信息 默认2个
    .logShowThreadInfoEnable(false) //是否打印线程信息   默认值 false
    .logWriteFileEnable(false) //是否将日志写入日志文件中 默认值 false
    .logFileAESEnable(
        false,
        "0000000000000000"
    ) //是否启动AES 加密 默认值 false ,可以不配秘钥 默认秘钥: 0000000000000000 注意秘钥字符串转byte数组必须是16个否则开启加密失败
    .logFileExtEnable(false) //是否将日志文件输出到外部私有空间 用于日志文件的提取 默认值 false
    .setDefaultTAG("LOGDOG") //自定义 设置,没有自行填写的TAG的统一缺省TAG 默认值:LOGDOG
    .encodingConfusion(false) //编码混淆 默认不开启 编码混淆只针对 log文件编码混淆 
    // 如果开启 不能在运行中和同一天(同一个日志文件)内发生更改编码混淆开关, 不然会造成 log文件 无法正确解密
    .logFileSize(10) //log文件大小分割 单位:MB
    .enabledNewLogCat(true) //对新版本LogCat的优化

V2.3.0 新增log 文件分享,具体新增配置 在AndroidManifest.xml 新增如下:


<provider android:name="com.ym521.logdog.provider.LogFileShareProvider"
    android:authorities="${applicationId}.fileshare" android:exported="false"
    android:grantUriPermissions="true">
    <meta-data android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/provider_paths" />
</provider>

使用:调用LogDog.logFileShare() 即可

java 配置信息同上kotlin; 但是需要注意的是: 1、秘钥转byte数组必须是16个否则开启加密不启动,建议可以采用16个非汉字组成秘钥!!! 2、logFileAESEnabl、logFileShowEnable 的启用前提是logWriteLogFileEnable 必须要开启

V2.5.6 优化对新版本LogCat的Log 打印:

             CS 
             ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━start━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
                 android.app.Activity.performCreate(Activity:7079) 
                     android.app.Activity.performCreate(Activity:7088) 
                         com.ym521.simp.MainActivity.onCreate(MainActivity:26) 
             ┣┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┅┫
             开始测试第一例  error 
             ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━end━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

在LogCat新版本中选择 compact view下 将无法显示的tag 添加到 log 顶部

  1. LogDog 功能使用
  LogDog.debug(tag, msg) //对应 Log.d 
LogDog.debugf(tag, msgformat, vararg) //msgformat可以使用String 占位符 %s 且只支持这个占位符

LogDog.info(tag, msg) //对应 Log.i
LogDog.infof(tag, msgformat, vararg) //msgformat可以使用String 占位符 %s 且只支持这个占位符

LogDog.warn(tag, msg) //对应 Log.w
LogDog.warnf(tag, msgformat, vararg) //msgformat可以使用String 占位符 %s 且只支持这个占位符

LogDog.error(tag, msg)//对应 Log.e
LogDog.errorf(tag, msgformat, vararg) //msgformat可以使用String 占位符 %s 且只支持这个占位符

//TODO 
// 注意:TAG属于可选参数,可以不填写,msg 不需要区分类型。
// Java使用 参考 Koltin使用示例代码
// msgformat可以使用String 占位符 %log 且只支持这个占位符

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

自定义日志框架:logdog (别称 日志狗) 展开 收起
Android 等 2 种语言
Apache-2.0
取消

发行版 (16)

全部

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Android
1
https://gitee.com/ym521/logdog.git
git@gitee.com:ym521/logdog.git
ym521
logdog
LogDog
master

搜索帮助