JIRA对接钉钉群机器人-实现任务的自定义格式指派通知

一、前提

Jira Software、钉钉群、RESTful服务、LDAP服务

二、流程图

 

三、对接步骤

1、创建项目群，把相关人员拉入群

2、钉钉群的智能群助手里添加自定义机器人

3、设置机器人，安全设置里建议勾选IP地址段，将RESTful服务所在的机器IP填入

4、注意创建完成后的Webhook地址，RESTful服务用这个地址发送通知消息，后面步骤要用上

5、RESTful服务新增一个POST接口，这里可以自定义通知内容，部署到服务器

@ApiOperation(value = "JIRA网络钩子")
@PostMapping("/jiraWebHook")
@ResponseBody
public Result<Boolean> jiraWebHook(HttpServletRequest request) {
    BufferedReader br = null;
    String str, wholeStr = "";
    try {
        br = request.getReader();

        while ((str = br.readLine()) != null) {
            wholeStr += str;
        }
        log.info("jiraWebHook body: {}", wholeStr);
    } catch (Exception e) {
        log.error("jiraWebHook error", e);
    } finally {
        if (br != null) {
            try {
                br.close();
            } catch (Exception e) {
            }
        }
    }
    return Result.success(JiraWebHookUtil.hook(JSONObject.parseObject(wholeStr, JiraPostData.class)));
}

@Slf4j
public class JiraWebHookUtil {

    private static final String DING_TALK_ROBOT_URL = "https://oapi.dingtalk.com/robot/send" +
            "?access_token=xxxxxx";
    private static final String JIRA_BASE_URL = "http://xxx.xxx.xxx.xxx:38080/browse/";
    private static RestTemplate restTemplate = new RestTemplate();

    public static boolean hook(JiraPostData postData){
        try {
            if(postData != null){
                if(StringUtils.equals(postData.getWebhookEvent(), "jira:issue_updated")){
                    //更新事件
                    List<Item> items = postData.getChangelog().getItems();
                    String toUserId = Strings.EMPTY;
                    String fromUserId = Strings.EMPTY;
                    for(Item item : items){
                        if(StringUtils.equals(item.getField(), "assignee")){
                            toUserId = item.getTo();
                            fromUserId = item.getFrom();
                            break;
                        }
                    }
                    if(StringUtils.isNotBlank(toUserId) && StringUtils.isNotBlank(fromUserId)){
                        String toMobile = getUserMobile(toUserId);
                        String fromMobile = getUserMobile(fromUserId);
                        if(StringUtils.isNotBlank(toMobile) && StringUtils.isNotBlank(fromMobile)){
                            String issueKey = postData.getIssue().getKey();
                            String issueSummary = postData.getIssue().getFields().getSummary();
                            DingTalkMarkdownMessage msg = new DingTalkMarkdownMessage();
                            msg.setMsgtype("markdown");
                            Markdown markdown = new Markdown();
                            markdown.setTitle(postData.getIssue().getKey());
                            markdown.setText("### @" + fromMobile + " 【转移任务给】@" + toMobile
                                    + "
>任务编号：[" + issueKey + "](" + JIRA_BASE_URL + issueKey + ")"
                                    + "  
任务标题：" + issueSummary);
                            msg.setMarkdown(markdown);
                            At at = new At();
                            at.setAtMobiles(Arrays.asList(toMobile, fromMobile));
                            msg.setAt(at);
                            return sendMsgToDingTalk(JSONObject.toJSONString(msg));
                        }
                    }
                }else if(StringUtils.equals(postData.getWebhookEvent(), "jira:issue_created")){
                    //创建事件
                    String fromUserId = postData.getUser().getKey();
                    String toUserId = postData.getIssue().getFields().getAssignee().getKey();
                    if(StringUtils.isNotBlank(toUserId) && StringUtils.isNotBlank(fromUserId)){
                        String toMobile = getUserMobile(toUserId);
                        String fromMobile = getUserMobile(fromUserId);
                        if(StringUtils.isNotBlank(toMobile) && StringUtils.isNotBlank(fromMobile)){
                            String issueKey = postData.getIssue().getKey();
                            String issueSummary = postData.getIssue().getFields().getSummary();
                            DingTalkMarkdownMessage msg = new DingTalkMarkdownMessage();
                            msg.setMsgtype("markdown");
                            Markdown markdown = new Markdown();
                            markdown.setTitle(postData.getIssue().getKey());
                            markdown.setText("### @" + fromMobile + " 【指派任务给】@" + toMobile
                                    + "
>任务编号：[" + issueKey + "](" + JIRA_BASE_URL + issueKey + ")"
                                    + "  
任务标题：" + issueSummary);
                            msg.setMarkdown(markdown);
                            At at = new At();
                            at.setAtMobiles(Arrays.asList(toMobile, fromMobile));
                            msg.setAt(at);
                            return sendMsgToDingTalk(JSONObject.toJSONString(msg));
                        }
                    }
                }
            }

        }catch (Exception e) {
            log.error("触发JIRA网络钩子失败", e);
        }
        return false;
    }

    private static boolean sendMsgToDingTalk(String msg){
        JSONObject postData = JSONObject.parseObject(msg);
        JSONObject result = restTemplate.postForObject(DING_TALK_ROBOT_URL, postData, JSONObject.class);
        if(result != null
                && result.getIntValue("errcode") == 0
                && StringUtils.equals(result.getString("errmsg"), "ok")){
            return true;
        }
        return false;
    }

    private static String getUserMobile(String userId){
        String mobile = Strings.EMPTY;

        Hashtable<String, String> env = new Hashtable<String, String>();
        env.put(Context.INITIAL_CONTEXT_FACTORY,"com.sun.jndi.ldap.LdapCtxFactory");
        env.put(Context.PROVIDER_URL, "ldap://xxxxxx:389");
        env.put(Context.SECURITY_AUTHENTICATION, "simple");
        env.put(Context.SECURITY_PRINCIPAL, "cn=xxx,dc=xxx,dc=xxx,dc=com");
        env.put(Context.SECURITY_CREDENTIALS, "xxxxxx");
        DirContext ctx = null;
        try{
            ctx = new InitialDirContext(env);
        }catch(Exception e){
            log.error("连接LDAP失败", e);
        }

        // 设置过滤条件
        String filter = "(&(objectClass=top)(objectClass=inetOrgPerson)(cn=" + userId + "))";
        // 限制要查询的字段内容
        String[] attrPersonArray = {"cn", "mobile"};
        SearchControls searchControls = new SearchControls();
        searchControls.setSearchScope(SearchControls.SUBTREE_SCOPE);
        // 设置将被返回的Attribute
        searchControls.setReturningAttributes(attrPersonArray);
        // 三个参数分别为：
        // 上下文；
        // 要搜索的属性，如果为空或 null，则返回目标上下文中的所有对象；
        // 控制搜索的搜索控件，如果为 null，则使用默认的搜索控件
        try {
            NamingEnumeration<SearchResult> answer = ctx.search(
                    "ou=People,dc=xxx,dc=xxx,dc=xxx", filter, searchControls);
            // 输出查到的数据
            while (answer.hasMore()) {
                SearchResult result = answer.next();
                Attribute attr = result.getAttributes().get("mobile");
                mobile = attr.get().toString();
                break;
            }
        }catch (Exception e){
            log.error("查询LDAP用户信息失败", e);
        }
        return mobile;
    }

}

6、Jira Software配置网络钩子，使用第5步的接口地址

四、验证效果