android-fully-log

this is a fully log system for debug/resolve problem on android

详细介绍及使用

使用场景：
       比如我们在开发和调试app过程中，有时候需要复现一些麻烦的Bug（经常测试测出来后）.才能方便的解决问题。
       这个库就是为了方便读写日志用的。
原理： 利用ipc进程间通信来读写日志。
特点： 支持日志的格式化，加解密，读写过滤。
       支持3种输出模式： logcat/文件/logcat+文件（文件中方便以后读取日志） 

API介绍：
    1, LogClient和LogServer 超类RemoteLogContext中：

    //设置和获取 ILogCipherer 日志加/解密器
    public ILogCipherer getLogCipherer() {
        return mLogCipherer;
    }
    public void setLogCipherer(ILogCipherer logCipherer) {
        if(logCipherer==null){
            throw new NullPointerException();
        }
        this.mLogCipherer = logCipherer;
    }

   //设置和获取 ILogWriterFilter 日志输出过滤器
    public ILogWriterFilter getLogWriterFilter() {
        return mWriteFilter;
    }
    public void setLogWriterFilter(ILogWriterFilter filter) {
        if(filter==null){
            throw new NullPointerException();
        }
        this.mWriteFilter = filter;
    }

 //设置和获取 ILogFormatter 日志格式化器
    public ILogFormatter getLogFormatter() {
        return mLogFormatter;
    }
    public void setLogFormatter(ILogFormatter logFormatter) {
        if(logFormatter==null){
            throw new NullPointerException();
        }
        this.mLogFormatter = logFormatter;
    }
    
    //destroy 日志客户端/服务端。相当于解绑远程服务
    public abstract  void destroy();

   2, LogClient特有的方法 :
          ps: (LogServer 没有特有的方法, 主要是提供日志读写服务.)

     /** 写日志
     * write the log to logcat or file or logcat and file
     * @param level the log level
     * @param tag the log tag
     * @param methodTag the method tag
     * @param exception the exception class name,can be null
     * @param message the content message
     */
    public void write(@LevelType  int level, String tag , String methodTag, String exception ,String message)

    /** 读日志
     * read the logs from local file. you should not call this more than once until it callback.
     * @param ops  the filter options,can be null, if you don't need fiter log (日志过滤器选项)
     * @param callback the read callback
     */
    public void readLog(LogFilterOptions ops, IReadCallback callback)

使用步骤：
    1，添加权限 : 读写sd卡和消息服务
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
    <uses-permission android:name="com.heaven7.android.ipc.service"/>. 
    和下面的Gradle config.
    
    2, 创建LogServer和LogClient. (创建时会自动绑定远程服务).
    
    3, 调用对应的api去读写日志。
    ps: 注意在适当的地方调用LogServer和LogClient.destroy().去解绑服务。

使用案例：

• 示例：android-fully-log-server-demo
• 里面注册了1个LogServer和1个LogClient. 方便并可以随时过滤查阅日志(也可以添加一条简单的日志)。
• 具体详见demo

Gradle config

  //日志客户端需要导入
  compile 'com.heaven7.android.log:fully-log:1.1.2'
  //日志服务端需要导入
  compile 'com.heaven7.android.ipc.server:ipc-server:1.1.1'

refer lib

ipc and ipc-server

License

Copyright 2015   
                heaven7(donshine723@gmail.com)

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.