toml4cj 库
介绍
TOML4CJ 旨在成为一个语义明显且易于阅读的最小化配置文件格式。TOML4CJ 被设计成可以无歧义地映射为哈希表。TOML4CJ 应该能很容易地被解析成各种语言中的数据结构。
参考toml语法规约地址: https://toml.io/cn/。
1 TOML4CJ 提供读取 toml 文件数据的功能
前置条件：NA
场景：
- 读取 toml 文件，支持 TOML4CJ v1.0.0
约束：NA
性能：NA
可靠性： 目前只实现对整数、浮点数、基础字符串、布尔类型字面量的解码。
1.1 toml 文件读取
1.1.1 主要接口
class Decoder
public class Decoder {
/*
* 初始化 Decoder
*/
public init()
/*
* 加载toml文件路径字符串
*
* 参数 pn - toml文件路径字符串, 只限于linux环境
*/
public func load(pn: String)
/*
* 加载toml文件路径字符串
*
* 参数 file - toml文件路径File对象
*/
public func load(file: File)
/*
* 解析toml文件返回生成json格式的对象
*
* 返回值 JsonObject - json对象
*/
public func decode(): JsonObject
}
1.1.2 示例
代码如下：
key = "value"
bare_key = "value"
bare-key = "value"
1234 = "value"
import toml4cj.decoders.*
main() {
let decoder: Decoder = Decoder()
decoder.load("integer002.toml")
let a = decoder.decode()
println(a)
}
运行结果如下：
{"key":"value","bare_key":"value","bare-key":"value","1234":"value"}
2 TOML4CJ 提供解析 toml 文件数据的功能
前置条件：NA
场景：
- 读取 toml 文件，支持 TOML4CJ v1.0.0
约束：
性能： NA
可靠性： 目前只实现对整数、浮点数、基础字符串、布尔类型字面量的解码。
2.1 toml 文件解析
2.1.1 主要接口
class Decoder
public class Decoder {
/*
* 初始化 Decoder
*/
public init()
/*
* 加载toml文件路径字符串
*
* 参数 pn - toml文件路径字符串, 只限于linux环境
*/
public func load(pn: String)
/*
* 加载toml文件路径字符串
*
* 参数 file - toml文件路径File对象
*/
public func load(file: File)
/*
* 解析toml文件返回生成json格式的对象
*
* 返回值 JsonObject - json对象
*/
public func decode(): JsonObject
}
2.1.2 示例
代码如下：
key = "value"
bare_key = "value"
bare-key = "value"
1234 = "value"
import toml4cj.decoders.*
main() {
let decoder: Decoder = Decoder()
decoder.load("integer002.toml")
let a = decoder.decode()
println(a)
}
运行结果如下：
{"key":"value","bare_key":"value","bare-key":"value","1234":"value"}
3 TOML4CJ 提供序列化 toml 数据的功能
前置条件：NA
场景：
- 读取toml文件，解析toml文件方便仓颉读取，支持 TOML4CJ v1.0.0
约束：目前只实现对整数、浮点数、基础字符串、布尔类型字面量的解码。
性能： NA
可靠性： NA
3.1 序列化成toml格式数据
3.1.1 主要接口
class TomlTz
public class TomlTz {
/*
* 初始化 TomlTz
* 参数 tomlOffset - 偏移量
*/
public init(tomlOffset: String)
/*
* 返回tzname 名称
*
* 返回值 String - 返回时区和偏移量的字符串
*/
public func tzname(): String
/*
* 返回UTC时区+偏移量的Duration
*
* 返回值 Duration - 返回时区和偏移量的Duration
*/
public func utcOffset(): Duration
/*
* 返回时间间隔Duration
*
* 返回值 Duration - 返回时间间隔Duration
*/
public func dst() : Duration
/*
* 返回系统本地时间Duration
*
* 返回值 Duration - 返回系统本地时间Duration
*/
public func location(): Location
}
3.1.2 示例
代码如下：
key = "value"
bare_key = "value"
bare-key = "value"
1234 = "value"
import toml4cj.decoders.*
main() {
let decoder: Decoder = Decoder()
decoder.load("integer002.toml")
let a = decoder.decode()
println(a)
}
运行结果如下：
{"key":"value","bare_key":"value","bare-key":"value","1234":"value"}
4 异常类
public class TomlBaseException <: Exception {
/*
* 得到一个 TomlBaseException 实例
*/
public init()
/*
* 得到一个 TomlBaseException 实例
* 参数 string - String 类型的异常信息
*/
public init(string: String)
}
public class TomlDecodeErrorException <: TomlBaseException {
/*
* 得到一个 TomlDecodeErrorException 实例
*/
public init()
/*
* 得到一个 TomlDecodeErrorException 实例
* 参数 string - String 类型的异常信息
*/
public init(string: String)
}
public class TomlIllegalKeyException <: TomlBaseException {
/*
* 得到一个 TomlIllegalKeyException 实例
*/
public init()
/*
* 得到一个 TomlIllegalKeyException 实例
* 参数 string - String 类型的异常信息
*/
public init(string: String)
}
public class TomlIllegalKeyException <: TomlBaseException {
/*
* 得到一个 TomlIllegalKeyException 实例
*/
public init()
/*
* 得到一个 TomlIllegalKeyException 实例
* 参数 string - String 类型的异常信息
*/
public init(string: String)
}
5 常量符号类
public class Symbols {
// "
static public let QUOTE: String = String.fromUtf8([0x22])
// \r
static public let CR: String = String.fromUtf8([0x0D])
// \n
static public let LF: String = String.fromUtf8([0x0A])
// \r\n
static public let CRLF: String = String.fromUtf8([0x0D, 0x0A])
// """
static public let TRIPLE_QUOTE: String = String.fromUtf8([0x22]) * 3
// '
static public let SINGLE_QUOTE: String = String.fromUtf8([0x27])
// '''
static public let TRIPLE_SINGLE_QUOTE: String = String.fromUtf8([0x27]) * 3
// =
static public let EQUAL_SYMBOL: String = String.fromUtf8([0x3D])
// #
static public let NUMBER_SIGN: String = String.fromUtf8([0x23])
// [
static public let LEFT_SQUARE_BRACKET: String = String.fromUtf8([0x5B])
// ]
static public let RIGHT_SQUARE_BRACKET: String = String.fromUtf8([0x5D])
// .
static public let DOT: String = String.fromUtf8([0x2E])
// _
static public let UNDERLINE: String = String.fromUtf8([0x5F])
// -
static public let DASHED: String = String.fromUtf8([0x2D])
// /
static public let FORWARD_SLASH: String = String.fromUtf8([0x5C])
// \
static public let BACK_SLASH: String = String.fromUtf8([0x2F])
// SPACE
static public let SPACE: String = String.fromUtf8([0x20])
// \t
static public let HORIZONTAL_TAB: String = String.fromUtf8([0x09])
// {
static public let LEFT_BRACE: String = String.fromUtf8([0x7B])
// }
static public let RIGHT_BRACE: String = String.fromUtf8([0x7D])
// +
static public let PLUS: String = String.fromUtf8([0x2B])
}