flexmark-java markdown给链接添加target属性

  • flexmark-javajava 版的 Markdown 转换工具,基本支持 Markdown 所有的语法,而且扩展性也不错;本文主要是通过扩展形式给链接添加 target 属性
  • 本文的扩展还将支持 Spring Properties 来动态配置, 支持域名排除、支持相对路径排除、支持自定义 target 属性的值.

定义Properties配置类 LinkTargetProperties

@Configuration
@ConfigurationProperties(prefix = "markdown.link")
public class LinkTargetProperties{
    /**
     * 排除添加 target 属性的链接
     */
    private List<String> excludes;
    /**
     * target 属性的值
     */
    private String target = "_target";

    /**
     * 相对路径排除
     */
    private boolean relativeExclude = true;
    
    // get 和 set 方法省略
}

实现 AttributeProvider的类 LinkTargetAttributeProvider

扩展 flexmark-java 主要是通过实现 AttributeProvider 进行修改

public class LinkTargetAttributeProvider implements AttributeProvider {
    // 用于获取配置的数据
    private final DataHolder dataHolder;
    // 绝对路径正则匹配
    private final Pattern pattern = Pattern.compile("^[a-zA-z]+://[^\\s]*");

    public LinkTargetAttributeProvider(DataHolder dataHolder) {
        this.dataHolder = dataHolder;
    }

    @Override
    public void setAttributes(@NotNull Node node, @NotNull AttributablePart part, @NotNull Attributes attributes) {
        // 只处理 Link 
        if (node instanceof Link && part == AttributablePart.LINK) {

            // 获取 href 标签
            Attribute hrefAttr = attributes.get("href");
            if (hrefAttr == null) {
                return;
            }
            // 值也不能为空
            String href = hrefAttr.getValue();
            if (StringUtils.isEmpty(href)) {
                return;
            }
            
            // 获取配置参数
            // 注意此处不能直接使用 Spring Boot 的依赖注入
            // 但可以使用ApplicatonContext.getBean的形式获取
            LinkTargetProperties dataKey = FlexmarkExtensions.LINK_TARGET.get(this.dataHolder);
            
            // 判断是否是绝对路径
            if (!pattern.matcher(href).matches()) {
                if (dataKey.isRelativeExclude()) {
                    // 如果是相对路径,则排除
                    return;
                }
            } else {
                
                // 获取域名/host
                Optional<String> host = ServletUtil.getHost(href);
                if (host.isEmpty()) {
                    return;
                }
                List<String> excludes = dataKey.getExcludes();
                if (excludes != null && !excludes.isEmpty()) {
                    
                    // 如果包含当前的host则排除
                    if (excludes.contains(host.get())) {
                        return;
                    }
                }
            }
            String target = dataKey.getTarget();
            if (StringUtils.isEmpty(target)) {
                target = "";
            }
            // 设置target 属性
            attributes.replaceValue("target", target);
        }
    }

    static AttributeProviderFactory factory() {
        return new IndependentAttributeProviderFactory() {
            @Override
            public @NotNull AttributeProvider apply(@NotNull LinkResolverContext linkResolverContext) {
                // 在此处获取dataHolder
                return new LinkTargetAttributeProvider(linkResolverContext.getOptions());
            }
        };
    }
}

在就版本中也可以通过 DataHoler.get(DataKey) 获取配置参数,现在已经不推荐使用了,这里推荐使用 linkResolverContext.getOptions()的形式

注册 Provider

自定义的Provider需要通过 HtmlRenderer.Builder.attributeProviderFactory 的方式注册才能使用

public class LinkTargetExtensions implements HtmlRenderer.HtmlRendererExtension {
    // 定义配置参数
    // 并设置默认值
    public static final DataKey<LinkTargetProperties> LINK_TARGET = new DataKey<>("LINK_TARGET", new LinkTargetProperties());
    @Override
    public void rendererOptions(@NotNull MutableDataHolder mutableDataHolder) {

    }

    @Override
    public void extend(HtmlRenderer.@NotNull Builder builder, @NotNull String s) {
        builder.attributeProviderFactory(LinkTargetAttributeProvider.factory());
    }

    public static LinkTargetExtensions create() {
        return new LinkTargetExtensions();
    }
}

Markdown 工具类

public class MarkdownUtil{
    private static final MutableDataSet OPTIONS = new MutableDataSet(
        PegdownOptionsAdapter.flexmarkOptions(
            true,
            // 所有的特性
            Extensions.ALL,
            // 自定义的 Link Target 扩展
            LinkTargetExtensions.create()
        ))
        .set(HtmlRenderer.SOFT_BREAK, "<br/>");
    
    // 解析器
    private static final Parser PARSER = Parser.builder(OPTIONS).build();

    // 渲染器
    private static final HtmlRenderer htmlRender = HtmlRenderer.builder(OPTIONS).build();
    
     /**
     * 渲染 Markdown 
     * @param markdown 文档
     * @param JDK8的Consumer的,用于动态改变 LinkTargetAttributeProvider的配置参数
     * @return html
     */
    public static String renderHtml(String markdown, Consumer<Document> accept) {
        if (Util.isEmpty(markdown)) {
            return "";
        }
        Document document = PARSER.parse(markdown);
        if (accept != null) {
            accept.accept(document);
        }
        return htmlRender.render(document);
    }
}

使用示例

public class TestMarkdownRender(){
    public static void main(String[] args) {
        String markdown = "[测试1](http://www.itlangzi.com/test1 '测试1') [测试2](/test2 '测试2') [测试3](https://www.google.com/test3 '测试3')";

        System.out.println(MarkdownUtil.renderHtml(markdown, doc -> {
            doc.set(LinkTargetExtensions.LINK_TARGET, new LinkTargetProperties(
                // 需要过滤的域名
                Arrays.asList("www.itlangzi.com","www.baidu.com"), 
                // target 属性的值
                "_target", 
                // 排除相对路径
                true
            ));
        }));
    }
}

结果

flexmark markdown.png

码砖不易,多多关注


作者: 小浪
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 小浪 !
 上一篇
jenkins 获取插件,下载插件提速,配置国内镜像 jenkins 获取插件,下载插件提速,配置国内镜像
jenkins 是目前比较流行的自动化运维工具,由于 jenkins 的镜像源是国外的所以再下载插件的时候会非常慢,甚至会超时,所以本文就重点介绍如何解决这个问题。 正确的做法自然是修改为国内的镜像源,本文使用的是清华大学的镜像源站 清华大学开源软件镜像站 主要分以下两种情况 1. 尚未安装的的情况 本文使用 war 其他类似 1.1 下载包 下载地址 jenkins.war下载地址 1.2 启
2020年4月26日
下一篇 
JSON和HTML之间互转实现 JSON和HTML之间互转实现
主要实现功能html转json,再由json恢复html 可去除 style 和 script 标签 将行内样式转换为 js object 将 class 转换为数组形式 主要依赖于 htmlparser2 ; 这是一个性能优越、功能强大的 html 解析库 直接上代码 import { Parser } from "htmlparser2" const numberValueRegexp =
2020年5月14日