Jira-Client 项目使用教程

1. 项目目录结构及介绍

jira-client/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── net/
│   │   │       └── rcarz/
│   │   │           └── jiraclient/
│   │   │               ├── BasicCredentials.java
│   │   │               ├── CustomFieldOption.java
│   │   │               ├── Field.java
│   │   │               ├── Issue.java
│   │   │               ├── JiraClient.java
│   │   │               ├── JiraException.java
│   │   │               └── ...
│   │   └── resources/
│   │       └── ...
│   └── test/
│       └── ...
├── .gitignore
├── .travis.yml
├── AUTHORS.md
├── LICENSE-LESSER.md
├── LICENSE.md
├── README.md
└── pom.xml

目录结构说明

• src/main/java/net/rcarz/jiraclient/: 包含项目的主要源代码，包括与JIRA REST API交互的客户端类和相关工具类。
• src/test/: 包含项目的测试代码，用于验证主要功能的正确性。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• .travis.yml: Travis CI的配置文件，用于持续集成和自动化测试。
• AUTHORS.md: 列出项目的贡献者。
• LICENSE-LESSER.md 和 LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• pom.xml: Maven项目的配置文件，定义了项目的依赖和构建配置。

2. 项目启动文件介绍

项目的启动文件主要是 JiraClient.java，位于 src/main/java/net/rcarz/jiraclient/ 目录下。

JiraClient.java

JiraClient.java 是项目的核心类，负责与JIRA REST API进行交互。它提供了创建、更新、查询和删除JIRA问题等功能。

主要方法

• JiraClient(String serverUrl, BasicCredentials credentials): 构造函数，初始化JiraClient实例。
• getIssue(String issueKey): 根据问题键获取JIRA问题。
• createIssue(String projectKey, String issueType): 创建新的JIRA问题。
• searchIssues(String jql): 使用JQL查询JIRA问题。
• getCustomFieldAllowedValues(String fieldId, String projectKey, String issueType): 获取自定义字段的允许值。

3. 项目配置文件介绍

pom.xml

pom.xml 是Maven项目的配置文件，定义了项目的依赖、构建配置和插件。

主要配置项

• dependencies: 定义了项目所需的依赖库，如Apache HttpComponents、json-lib和joda-time。
• build: 定义了项目的构建配置，包括编译、测试和打包等步骤。

.travis.yml

.travis.yml 是Travis CI的配置文件，用于自动化构建和测试。

主要配置项

• language: 指定项目使用的编程语言，如Java。
• jdk: 指定使用的JDK版本。
• script: 定义构建和测试的命令。

README.md

README.md 是项目的介绍和使用说明文件，提供了项目的概述、安装步骤、示例代码和常见问题解答。

主要内容

• 项目概述: 简要介绍项目的功能和目标。
• 安装步骤: 详细说明如何安装和配置项目。
• 示例代码: 提供使用JiraClient的示例代码。
• 常见问题解答: 解答用户可能遇到的问题。

通过以上配置文件和启动文件，用户可以快速了解和使用Jira-Client项目。