Как визуализировать шаблон скорости на панели вкладок задач?

Чтобы отрендерить шаблоны скорости, вам нужно импортировать 5 классов.

import com.atlassian.jira.config.properties.APKeys;
import com.atlassian.jira.config.properties.ApplicationProperties;
import com.atlassian.jira.util.VelocityParamFactory;
import com.atlassian.velocity.VelocityManager;
import com.atlassian.jira.component.ComponentAccessor;
import com.atlassian.jira.config.properties.APKeys;

Внутри вашей функции вам нужно инициализировать ComponentAccessor и получить свойства приложения

ApplicationProperties ap = ComponentAccessor.getApplicationProperties();

Когда у вас есть свойства приложения «ap», вы можете получить ключи приложения, от которых зависит менеджер Velocity.

String baseUrl = ap.getString(APKeys.JIRA_BASEURL);
String webworkEncoding = ap.getString(APKeys.JIRA_WEBWORK_ENCODING);

После того, как у вас есть baseUrl и webworkEncoding, вы можете перейти к инициализации VelocityManager и VelocityParamFactory. Эти два класса позволяют вам создать менеджер, который позволяет вам кодировать ваш шаблон или получить тело вашего шаблона, а также получить параметры по умолчанию. на шаблон скорости.

VelocityManager vm = ComponentAccessor.getVelocityManager();
VelocityParamFactory vp = ComponentAccessor.getVelocityParamFactory();

После их инициализации вы должны создать Map значений контекста, которые назначаются VelocityParamFactory, что позволит вам получить и установить параметры для каждого шаблона. Которые вы можете передать в значениях, которые будут использоваться позже в вашем шаблоне скорости.

Map context = vp.getDefaultVelocityParams(); 

Используя карту context, которую вы настроили ранее, вы можете начать присваивать значения переменной контекста с помощью метода put, который впоследствии будет использоваться в шаблоне скорости.

context.put("testVariable", ["Value can be a string or an array or a collection"]);

Если у вас есть это предположение, что вы хотите визуализировать шаблон скорости, вы можете использовать либо метод getBody, либо метод getEncodedBody. Оба по сути делают одно и то же, но работают совершенно по-разному. Я предлагаю прочитать о том, как использовать каждый из них и какой вариант использования является правильным для любого или.

String renderedText = vm.getEncodedBody("templates/", "service-now-tab-panel.vm", baseUrl, webworkEncoding, context);

Вам нужно установить templatePath, templateFile, baseUrl, webWorkEncoding и, наконец, context, который содержит любой из параметров, которые вы поместили в контекст, который затем будет возвращен в шаблоне скорости в переменную renderedText в виде строки.

В зависимости от того, как и что вы делаете в Jira, есть несколько способов передать это в ваше представление. Я оставлю это на ваше усмотрение, но то, что я сделал при создании IssueTabPanel, заключалось в том, чтобы отобразить его, как показано ниже:

return Collections.singletonList(new GenericMessageAction( renderedText ));

Итак, все вместе должно выглядеть так:

ApplicationProperties ap = ComponentAccessor.getApplicationProperties();
String baseUrl = ap.getString(APKeys.JIRA_BASEURL);
String webworkEncoding = ap.getString(APKeys.JIRA_WEBWORK_ENCODING);

VelocityManager vm = ComponentAccessor.getVelocityManager();
VelocityParamFactory vp = ComponentAccessor.getVelocityParamFactory();

Map context = vp.getDefaultVelocityParams();
context.put("test", "test");

String renderedText = vm.getEncodedBody("templates/", "service-now-tab-panel.vm", baseUrl, webworkEncoding, context);

return Collections.singletonList(new GenericMessageAction(renderedText));

Это мое понимание того, как это работает, исходя из исследований. Это может быть не лучший способ сделать это и, возможно, не абсолютно правильный способ, но этот метод будет работать! Если у кого-то есть какие-либо дополнения к этому, чтобы сделать его более понятным и тщательным, пожалуйста, отредактируйте его или превратите в вики.