SpringBoot使用Editor.md构建Markdown富文本编辑器

时间 2019-12-06

标签 springboot 使用 editor.md editor 构建 markdown 文本编辑器栏目 Spring 繁體版

原文原文链接

Markdown是一种可使用普通文本编辑器编写的标记语言，经过简单的标记语法，它可使普通文本内容具备必定的格式。javascript

前言

Editor.md 是一款开源的、可嵌入的 Markdown 在线编辑器（组件），基于 CodeMirror、jQuery 和 Marked 构建。本章将使用SpringBoot整合Editor.md构建Markdown编辑器。css

下载插件

项目地址：Editor.mdhtml

解压目录结构： java

https://user-gold-cdn.xitu.io/2018/3/15/1622a163bb8424b5?w=755&h=629&f=png&s=49125

配置Editor.md

将exapmles文件夹中的simple.html放置到项目中，并配置对应的css和js文件jquery

配置编辑器

......
	<script src="${re.contextPath}/jquery.min.js"></script>
    <script src="${re.contextPath}/editor/editormd.min.js"></script>
    <link rel="stylesheet" href="${re.contextPath}/editor/css/style.css"/>
    <link rel="stylesheet" href="${re.contextPath}/editor/css/editormd.css"/>
    <link rel="shortcut icon" href="https://pandao.github.io/editor.md/favicon.ico" type="image/x-icon"/>
......
<!-- 存放源文件用于编辑 -->
 <textarea style="display:none;" id="textContent" name="textContent">
</textarea>
        <!-- 第二个隐藏文本域，用来构造生成的HTML代码，方便表单POST提交，这里的name能够任意取，后台接受时以这个name键为准 -->
        <textarea id="text" class="editormd-html-textarea" name="text"></textarea>
    </div>
复制代码

初始化编辑器

var testEditor;

    $(function () {
        testEditor = editormd("test-editormd", {
            width: "90%",
            height: 640,
            syncScrolling: "single",
            path: "${re.contextPath}/editor/lib/",
            imageUpload: true,
            imageFormats: ["jpg", "jpeg", "gif", "png", "bmp", "webp"],
            imageUploadURL: "/file",
            //这个配置在simple.html中并无，可是为了可以提交表单，使用这个配置可让构造出来的HTML代码直接在第二个隐藏的textarea域中，方便post提交表单。
            saveHTMLToTextarea: true
            // previewTheme : "dark"
        });
    });
复制代码

这样就实现了最简单的editor.md编辑器，效果以下：git

https://user-gold-cdn.xitu.io/2018/3/15/1622a163bba5ecdb?w=1155&h=673&f=png&s=61065

访问地址：http://localhost:8080/

图片上传

因为在初始化编辑器中配置的图片上传地址为imageUploadURL: "/file",，与之对应，咱们在/file处理文件上传便可github

@RestController
@RequestMapping("/file")
@Slf4j
public class FileController {

// @Value("")
// String folder = System.getProperty("user.dir")+File.separator+"upload"+File.separator;
    /** * 在配置文件中配置的文件保存路径 */
    @Value("${img.location}")
    private String folder;

    @PostMapping
    public FileInfo upload(HttpServletRequest request, @RequestParam(value = "editormd-image-file", required = false) MultipartFile file) throws Exception {
        log.info("【FileController】 fileName={},fileOrginNmae={},fileSize={}", file.getName(), file.getOriginalFilename(), file.getSize());
        log.info(request.getContextPath());
        String fileName = file.getOriginalFilename();
        String suffix = fileName.substring(fileName.lastIndexOf(".") + 1);
        String newFileName = new Date().getTime() + "." + suffix;

        File localFile = new File(folder, newFileName);
        file.transferTo(localFile);
        log.info(localFile.getAbsolutePath());
        return new FileInfo(1, "上传成功", request.getRequestURL().substring(0,request.getRequestURL().lastIndexOf("/"))+"/upload/"+newFileName);
    }

    @GetMapping("/{id}")
    public void downLoad(@PathVariable String id, HttpServletRequest request, HttpServletResponse response) {
        try (InputStream inputStream = new FileInputStream(new File(folder, id + ".txt"));
             OutputStream outputStream = response.getOutputStream();) {
            response.setContentType("application/x-download");
            response.setHeader("Content-Disposition", "attachment;filename=test.txt");

            IOUtils.copy(inputStream, outputStream);
            outputStream.flush();
        } catch (Exception e) {

        }
    }
}

复制代码

文件预览

表单POST提交时，editor.md将咱们的markdown语法文档翻译成了HTML语言，并将html字符串提交给了咱们的后台，后台将这些HTML字符串持久化到数据库中。具体在页面显示作法以下：web

<!DOCTYPE html>
<html lang="zh">
<head>
    <meta charset="utf-8"/>
    <title>Editor.md examples</title>
    <link rel="stylesheet" href="${re.contextPath}/editor/css/editormd.preview.min.css" />
    <link rel="stylesheet" href="${re.contextPath}/editor/css/editormd.css"/>
</head>
<body>
<!-- 由于咱们使用了dark主题，因此在容器div上加上dark的主题类，实现咱们自定义的代码样式 -->
<div class="content editormd-preview-theme" id="content">${editor.content!''}</div>
<script src="${re.contextPath}/jquery.min.js"></script>
<script src="${re.contextPath}/editor/lib/marked.min.js"></script>
<script src="${re.contextPath}/editor/lib/prettify.min.js"></script>
<script src="${re.contextPath}/editor/editormd.min.js"></script>
<script type="text/javascript"> editormd.markdownToHTML("content"); </script>
</body>
</html>
复制代码

预览地址：http://localhost:8080/editorWeb/preview/{id}数据库
编辑地址：http://localhost:8080/editorWeb/edit/{id}小程序

代码下载

从个人 github 中下载，github.com/longfeizhen…

https://user-gold-cdn.xitu.io/2018/3/9/16209a19fc30f23d?w=301&h=330&f=png&s=78572

🙂🙂🙂关注微信小程序java架构师历程 上下班的路上无聊吗？还在看小说、新闻吗？不知道怎样提升本身的技术吗？来吧这里有你须要的java架构文章，1.5w+的java工程师都在看，你还在等什么？