emoji-java 开源项目安装与使用指南

emoji-java 开源项目安装与使用指南

emoji-javaThe missing emoji library for Java :heart:项目地址:https://gitcode.com/gh_mirrors/em/emoji-java

目录结构及介绍

目录结构概览

当你克隆或下载 vdurmont/emoji-java 项目时, 你会看到以下的主要目录结构:

.
├── .travis.yml                    # Travis CI 配置文件
├── CHANGELOG.md                   # 更新日志
├── DEPLOY.md                      # 部署说明
├── EMOJIS.md                      # Emoji 数据表文档
├── LICENSE.md                     # 许可证文件
├── README.md                      # 读我文件，项目说明
├── emoji-table-generator          # 自动生成 emoji 数据表的目录
│   ├── src                        # 代码源文件
│   │   └── main                  # 主程序源码
│   │       └── resources         # 资源文件夹
│   │           └── emojis        # 存放 emoji 数据的地方
│   │               └── i18n.json # 多语言支持的 JSON 文件
│   ├── pom.xml                   # Maven 构建文件
└── pom.xml                       # 根 Maven 构建文件

各部分简介

• emoji-table-generator: 此目录下的代码负责从各种来源抓取和整理最新的 emoji 数据. 执行这些脚本后将会更新 emojis/i18n.json, 该文件会被用来构建整个 emoji 库.

• src/main/resources/emojis/i18n.json: 这个文件包含了所有 emoji 的数据, 包括它们的 Unicode 编码 和对应的别名.

• pom.xml: Maven 构建文件, 控制项目的依赖关系和构建过程.

• .travis.yml: 这个文件定义了在 Travis CI 上运行自动化测试和构建任务的具体指令.

项目的启动文件介绍

由于这是一个库而不是应用, 不会有传统意义上的"启动文件". 但是你可以通过 Gradle 或者 Maven 添加此库作为你的项目的依赖项. 下面是如何在你的 build.gradle 文件中添加这个依赖的例子:

dependencies {
    implementation 'com.vdurmont:emoji-java:5.1.1'
}

对于 Maven 的 pom.xml, 你需要添加如下依赖:

<dependency>
    <groupId>com.vdurmont</groupId>
    <artifactId>emoji-java</artifactId>
    <version>5.1.1</version>
</dependency>

一旦你把 emoji-java 添加为你的项目的依赖, 你就可以开始在你的代码中调用它的方法了.

例如, 使用一个 emoji 的别名查找对应的 Unicode 字符串:

import com.vdurmont.emoji.Emoji;
import com.vdurmont.emoji.EmojiManager;

public class App {
    public static void main(String[] args) {
        Emoji emoji = EmojiManager.getForAlias("smile");
        System.out.println(emoji);
    }
}

这段代码将打印出代表微笑的表情 (😄) 的完整 Emoji 对象.

如果你没有在 IDE 内部使用 Gradle 或 Maven 来管理项目, 你也可以下载 JAR 文件并将其添加到你的项目构建路径中.

项目的配置文件介绍

项目自身并不需要配置文件, 但它可以处理来自 src/main/resources/emojis/i18n.json 的配置数据, 这个文件是 emoji 数据的基础, 当你想要更新库中的 emoji 或添加新的 emoji 支持时, 你应该编辑这个文件. 更具体地说:

• i18n.json 包含了一个由 emoji 名字映射至其编码和其他属性的对象数组. 你可以在其中找到诸如 name, unicode, aliases 等字段.

• 在每次发布新版本之前, 需要通过 emoji-table-generator 目录下的代码自动更新这个文件.

如果你想进行自定义并且不希望每次更新库时都破坏你的更改, 最好的办法是使用前面提到的几种方案之一覆盖默认的 i18n.json. 例如, fork 该项目并在你的分支上生成自己的 i18n.json 文件. 接下来, 把它作为一个私有的依赖加入你的项目中, 或者在一个类似于 EmojiManager 的自定义类中重新加载它.

请注意, 为了使 emoji-java 正确解析你的 emoji 数据, 遵循原始文件的格式和结构是非常重要的.

emoji-javaThe missing emoji library for Java :heart:项目地址:https://gitcode.com/gh_mirrors/em/emoji-java