TextRecorder

一个文本记录工具，不限定文本具体格式，也不限定文本处理方式，比如你可以将普通文本、异常信息等记录在本地文件中。

效果

使用项目提供的默认记录方式效果如下：

使用项目提供的markdown记录方式效果如下：

用法

1. 添加引用

首先需要添加核心库（必须）：

compile 'com.github.naturs.text.recorder:text-recorder:1.5.1'

如果采用默认的converter（可自定义，将文本转换为指定格式的字符串）：

compile 'com.github.naturs.text.recorder:text-recorder-converter:1.5.1'

如果采用默认的processor（可自定义，将文本内容保存到文件）：

compile 'com.github.naturs.text.recorder:text-recorder-processor:1.5.1'

如果使用Markdown格式来转换文本内容（可自定义，替换默认的converter）：

compile 'com.github.naturs.text.recorder:text-recorder-markdown:1.5.1'

注意，如果是运行在Java环境中使用，需要添加json相关包：

compile 'org.json:json:20160212'

示例（Android环境）：

// 默认方式
compile 'com.github.naturs.text.recorder:text-recorder:1.5.1'
compile 'com.github.naturs.text.recorder:text-recorder-converter:1.5.1'
compile 'com.github.naturs.text.recorder:text-recorder-processor:1.5.1'

// Markdown方式，markdown包中不包含processor相关处理方式
compile 'com.github.naturs.text.recorder:text-recorder:1.5.1'
compile 'com.github.naturs.text.recorder:text-recorder-processor:1.5.1'
compile 'com.github.naturs.text.recorder:text-recorder-markdown:1.5.1'

2. 初始化

TextRecorder需要添加默认配置，以便后续调用。

初始化方式如下：

TextRecorder.init(
    Scheduler,
    TextLineConverter.Factory,
    TextLineProcessor.Factory,
    LogPrinter
);

其中参数含义如下：

Scheduler，代表处理文本的线程，默认可使用Schedulers.io()；
TextLineConverter.Factory，代表将文本对象TextLine转换成最终处理的字符串的转换器的工厂对象，你可以通过该工厂你可以将文本对象转换成任何你需要的文本字符串；
TextLineProcessor.Factory，代表最终处理文本对象内容的处理器的工厂对象，一般来说，它会处理TextLineConverter转换后的数据，你可以通过该工厂以任意方式来处理你的文本内容，比如记录到本地文件中；
LogPrinter，打印日志的接口，可根据运行环境来配置，比如Android下使用android.util.Log来打印日志；

3. 使用

3.1 默认方式

项目中提供了GenericTextLine类作为处理文本记录的默认类，该类可记录以下文本内容：

普通文本；
JSON；
XML；
异常信息；
分割线（为了使最终文本内容更易阅读）；
空行（为了使最终文本内容更易阅读）；

TextRecorder默认使用GenericTextLine来记录文本内容。

示例：（可参考Sample.java）

// 参数tag代表日志标签，最终会在Converter或Processor中用到
TextRecorder recorder = TextRecorder.with("module");
// 每一个append都是一条记录，可同时记录多条
recorder.append(String)
		.append(Throwable)
		.appendJson(JSON)
		.appendXml(XML)
		.appendBlankLine()
		.appendDivider();
// 同步提交
recorder.commit();
// OR 异步提交
recorder.apply();

3.2 自定义方式

部分情况下，默认记录方式可能不适合实际情况，可按下面步骤实现自定义记录方式。

实现自定义的TextLine；
实现自定义的TextLineConverter及TextLineConverter.Factory；
实现自定义的TextLineProcessor及TextLineProcessor.Factory；
使用自定义的TextLineConverter.Factory和TextLineProcessor.Factory初始化TextRecorder，并用自定义TextLine进行文本记录；
使用TextRecorder进行内容提交；

示例：（可参考SampleMarkdown.java）

TextRecorder recorder = TextRecorder.with("markdown");

MarkdownTextLine textLine = MarkdownTextLine.with().text("I'm a text.");
recorder.append(textLine);

RuntimeException exception = new RuntimeException("mock an exception.");
textLine = MarkdownTextLine.with().throwable("I'm an exception.", exception);
recorder.append(textLine);

textLine = MarkdownTextLine.with().divider();
recorder.append(textLine);

textLine = MarkdownTextLine.with().json("I'm a json.", Sample.JSON);
recorder.append(textLine);

textLine = MarkdownTextLine.with().xml("I'm a xml.", Sample.XML);
recorder.append(textLine);

recorder.apply();

License

Copyright 2017 naturs

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.

naturs/TextRecorder

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 2

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages