使用go-jira库实现JIRA API交互

go-jira是一个流行的Golang库，用于与Atlassian JIRA进行交互。下面我将详细介绍如何使用这个库实现常见的JIRA操作。

安装go-jira

首先安装go-jira库：

go get github.com/andygrunwald/go-jira/v2

基本配置和认证

go-jira支持多种认证方式，最常用的是基本认证(Basic Auth)和个人访问令牌(PAT)。

1. 基本认证示例

package main

import (
	"fmt"
	"net/http"
	"os"

	jira "github.com/andygrunwald/go-jira/v2/cloud"
)

func main() {
	// JIRA Cloud的API地址
	jiraURL := "https://your-domain.atlassian.net"

	// 创建Transport并设置认证信息
	tp := jira.BasicAuthTransport{
		Username: "your-email@example.com",
		Password: "your-api-token", // 对于JIRA Cloud，使用API令牌而非密码
	}

	// 创建JIRA客户端
	client, err := jira.NewClient(jiraURL, tp.Client())
	if err != nil {
		fmt.Printf("创建JIRA客户端失败: %v\n", err)
		os.Exit(1)
	}

	// 测试连接
	_, _, err = client.User.GetSelf()
	if err != nil {
		fmt.Printf("认证失败: %v\n", err)
		os.Exit(1)
	}

	fmt.Println("成功连接到JIRA!")
}

2. 个人访问令牌(PAT)认证

tp := jira.PATAuthTransport{
	Token: "your-personal-access-token",
}

client, err := jira.NewClient(jiraURL, tp.Client())

常见操作示例

1. 创建Issue

func createIssue(client *jira.Client) {
	i := jira.Issue{
		Fields: &jira.IssueFields{
			Description: "这是一个测试问题",
			Type:        jira.IssueType{Name: "Task"},
			Project:     jira.Project{Key: "PROJ"},
			Summary:     "测试问题",
		},
	}

	issue, _, err := client.Issue.Create(&i)
	if err != nil {
		fmt.Printf("创建问题失败: %v\n", err)
		return
	}

	fmt.Printf("成功创建问题: %s\n", issue.Key)
}

2. 获取Issue详情

func getIssue(client *jira.Client, issueKey string) {
	issue, _, err := client.Issue.Get(issueKey, nil)
	if err != nil {
		fmt.Printf("获取问题失败: %v\n", err)
		return
	}

	fmt.Printf("问题详情:\n")
	fmt.Printf("Key: %s\n", issue.Key)
	fmt.Printf("Summary: %s\n", issue.Fields.Summary)
	fmt.Printf("Status: %s\n", issue.Fields.Status.Name)
	fmt.Printf("Description: %s\n", issue.Fields.Description)
}

3. 搜索Issue

func searchIssues(client *jira.Client, jql string) {
	issues, _, err := client.Issue.Search(jql, nil)
	if err != nil {
		fmt.Printf("搜索问题失败: %v\n", err)
		return
	}

	fmt.Printf("找到 %d 个问题:\n", len(issues))
	for _, issue := range issues {
		fmt.Printf("%s: %+v\n", issue.Key, issue.Fields.Summary)
	}
}

// 使用示例
searchIssues(client, "project = PROJ AND status = Open")

4. 更新Issue

func updateIssue(client *jira.Client, issueKey string) {
	// 获取当前问题
	issue, _, err := client.Issue.Get(issueKey, nil)
	if err != nil {
		fmt.Printf("获取问题失败: %v\n", err)
		return
	}

	// 创建更新
	update := jira.Issue{
		Key: issueKey,
		Fields: &jira.IssueFields{
			Summary:     "更新后的摘要",
			Description: "更新后的描述",
		},
	}

	_, err = client.Issue.Update(&update)
	if err != nil {
		fmt.Printf("更新问题失败: %v\n", err)
		return
	}

	fmt.Printf("成功更新问题 %s\n", issueKey)
}

5. 添加评论

func addComment(client *jira.Client, issueKey string, comment string) {
	c := &jira.Comment{
		Body: comment,
	}

	_, _, err := client.Issue.AddComment(issueKey, c)
	if err != nil {
		fmt.Printf("添加评论失败: %v\n", err)
		return
	}

	fmt.Printf("成功添加评论到问题 %s\n", issueKey)
}

高级功能

1. 分页获取结果

func paginatedSearch(client *jira.Client, jql string) {
	opts := &jira.SearchOptions{
		StartAt:    0,
		MaxResults: 50, // 每页数量
	}

	for {
		issues, resp, err := client.Issue.Search(jql, opts)
		if err != nil {
			fmt.Printf("搜索问题失败: %v\n", err)
			break
		}

		fmt.Printf("当前页: %d-%d (总数: %d)\n", 
			opts.StartAt, 
			opts.StartAt+len(issues)-1, 
			resp.Total)

		for _, issue := range issues {
			fmt.Printf("%s: %s\n", issue.Key, issue.Fields.Summary)
		}

		if opts.StartAt+len(issues) >= resp.Total {
			break
		}

		opts.StartAt += len(issues)
	}
}

2. 获取所有自定义字段

func getCustomFields(client *jira.Client) {
	fields, _, err := client.Field.GetList()
	if err != nil {
		fmt.Printf("获取字段列表失败: %v\n", err)
		return
	}

	fmt.Println("自定义字段:")
	for _, field := range fields {
		if field.Custom {
			fmt.Printf("%s (ID: %s)\n", field.Name, field.ID)
		}
	}
}

3. 使用自定义字段创建Issue

func createIssueWithCustomField(client *jira.Client) {
	i := jira.Issue{
		Fields: &jira.IssueFields{
			Type:    jira.IssueType{Name: "Bug"},
			Project: jira.Project{Key: "PROJ"},
			Summary: "带有自定义字段的问题",
			Unknowns: map[string]interface{}{
				"customfield_12345": "自定义值", // 替换为实际的字段ID
			},
		},
	}

	issue, _, err := client.Issue.Create(&i)
	if err != nil {
		fmt.Printf("创建问题失败: %v\n", err)
		return
	}

	fmt.Printf("成功创建带有自定义字段的问题: %s\n", issue.Key)
}

错误处理

go-jira返回的错误通常包含详细的JIRA API错误信息：

_, resp, err := client.Issue.Create(&issue)
if err != nil {
    if resp != nil {
        fmt.Printf("HTTP状态码: %d\n", resp.StatusCode)
        // 读取响应体获取详细错误信息
        body, _ := io.ReadAll(resp.Body)
        fmt.Printf("响应体: %s\n", string(body))
    }
    fmt.Printf("错误详情: %v\n", err)
    return
}

总结

go-jira库提供了全面的JIRA API访问能力，包括：

1. 问题管理（创建、读取、更新、删除）
2. 搜索功能（JQL查询）
3. 工作流操作（转换状态）
4. 附件管理
5. 用户和权限管理

通过合理使用这个库，可以构建强大的JIRA集成工具和自动化脚本。记得在生产环境中添加适当的错误处理和日志记录，并考虑使用上下文(Context)来控制请求超时等行为。