zl程序教程

您现在的位置是:首页 >  Java

当前栏目

嘀咕(哔哔)Memos 简介

2023-02-18 16:34:47 时间

TL;DR

本文介绍了 Memos 的部署,数据导入,公告栏 API 调用,和 “ 嘀咕” 页面通过 API 渲染 Memos。

前言

DEMO:https://eallion.com/memos/

我从接触独立博客开始,就一直在博客的子栏目中部署了一个类似 嘀咕 的微博客。 最初的作用是备份 QQ 空间、Twitter 和微博等。 最早用到的微博客程序是 PageCookery。甚至有点怀念……

现在在独立博客圈少部博主中流行的这种“B 言 B 语”,最早来源于少数派上的一篇文章——《保卫表达:用后端 BaaS 快速搭建专属无点赞评论版微博——b 言 b 语》,“B 言 B 语”也叫“废话胶囊”。

由此也衍生出了:

目前以上版本均可使用,不过可能有些版本的使用成本有点高。

今天要介绍的是另一个能提供类似功能的应用——Memos Memos 自己对标的竞品是 Flomo ,我们是不是把它用歪了?

部署 Memos

前置条件:

  1. 一台 VPS 服务器或本地电脑(或 Docker SaaS 平台)
  2. 一点点 WebStack 技能(Docker、Nginx)

安装docker-compose-plugin插件后,docker compose命令可以去掉中间的"-",Docker Compose V1 版本已经结束生命周期。

暂时不建议把 Memos 部署到网站二级目录,如:https://example.com/memos 而应该部署到一个二级域名,如:https://memos.example.com

  1. 新建 docker-compose.yml

一般在准备用于 Memos 的域名的目录下新建docker-compose.yml文件:

cd /www/wwwroot/memos.example.com
vim docker-compose.yml

输入以下内容:

version: "3.0"
services:
    memos:
        image: neosmemo/memos
        container_name: memos
        volumes:
            - ./memos/:/var/opt/memos
        ports:
            - 5230:5230
        restart: always
  1. 启动 Memos

启动 Memos

docker compose up -d

等待镜像拉取完成,Memos 就运行在服务器的5230端口了。 此时,打开http://127.0.0.1:5230就能访问 Memos 了。 如果有公网 IP,那就打开IP+端口,如: http://119.29.29.29:5230 。 用域名反代 IP 见下文第 4 点。 常用的命令有:

docker compose up -d
docker compose down
docker compose pull
docker compose up -d --force-recreate
  1. 升级 Memos

参考:https://memos.eallion.com/m/5454

Memos 官方提供的升级命令

docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d

会导致 Memos 在升级期间掉线,因为 down 了,特别是境内服务器网速不好的情况下,掉线时间会随着 pull 时间无限延长。

最新版 Docker 升级 Memos 的命令有改进空间:

docker compose pull && docker compose up -d --force-recreate

但是如果用了镜像加速服务,因为缓存的原因也可能有 pull 不到最新镜像的问题。

  1. Nginx 反代

如果打算对互联网提供 Memos 访问服务,就需要反代 Memos,一般都是用 Nginx,反代5230端口即可。

location ^~ /
{
    proxy_pass http://127.0.0.1:5230;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header REMOTE-HOST $remote_addr;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection $connection_upgrade;
    add_header X-Cache $upstream_cache_status;
    # cache
    add_header Cache-Control no-cache;
    expires 12h;
}

一些主机管理面板提供可视化反代设置,那更简单。

  1. 备份数据

在第 1 步中的docker-compose.yml文件中,

    volumes:
      - ./memos/:/var/opt/memos

这段就是数据持久化配置,如果不做数据持久化,Docker 容器重启后,所有 Memos 都会消失。 “:”冒号前面的内容是物理宿主机上的目录,例子中对应的目录为:

/www/wwwroot/memos.example.com/memos

需要备份的数据是此目录下的memos_prod.db文件,是一个 SQLite 数据库文件,Memos 的所有设置、用户信息、附件和 Memos 都保存在这个文件中。 官方提供的示例中,数据卷为家目录/home/username下的.memos目录,是一个隐藏目录,注意对比。

导入数据到 Memos

迁移平台后,原来其他平台的数据肯定希望能导入到新平台,但 Memos 官方还没有提供导入导出服务。 不过既然知道了 Memos 是用 SQLite 数据库保存的数据,那就转变思想,直接操作 SQLite db 文件即可。

  1. 方法一:命令行

先在 Memos 网页端随意发布一条 Memos,然后下载memos_prod.db文件,导出一个.csv文件作为模板。 打开数据库:

sqlite3 memos_prod.db

打开数据库后导出.csv

sqlite> .headers on
sqlite> .mode csv
sqlite> .separator ','
sqlite> .output memos.csv
sqlite> select * from `memo`;
sqlite> .quit

导出的模板文件为memos.csv,用类似 Notepad++ 这类软件打开导入的 CSV 文件,把编码修改为UTF-8-BOM编码,不然重新导入到 Memos 后,中文会有乱码。

按照它的格式转换以前的数据:

保存后用命令导入到memos_prod.db这个 SQLite 数据库。 先打开数据库:

sqlite3 memos_prod.db

打开数据库后导入:

sqlite> .headers on
sqlite> .mode csv
sqlite> .separator ','
sqlite> .import memos.csv memo
sqlite> .quit

然后把新的memos_prod.db文件上传到服务器上的memos文件夹替换掉原来的文件,重启容器即可。 如果有权限问题,需要修改一下文件访问权限:

sudo chown www:www memos_prod.db
  1. 方法二:数据库管理工具

SQLite 数据管理工具有免费的 SQLiteStudio,也有收费的 Navicat 。 Navicat 虽然收费,但是有 14 天的试用期,14 天足够用了?吧。

打开 Navicat 后,连接 memos_prod.db

依次点开“memos”-main--memo,在memo表上点击右键,选择导出向导, 选择一种熟悉的文件格式:

一路默认下一步到底,点开始导出就行了。

打开导出的文件,按照格式添加以前的数据。

然后在打开的数据库左侧点击右键导入就行了。

最后把新的memos_prod.db文件上传到服务器上的memos文件夹替换掉原来的文件,重启容器即可。 如果有权限问题,需要修改一下文件访问权限:

sudo chown www:www memos_prod.db

CSS:自定义 Memos 样式

/*隐藏每条可见状态标签*/
.user-banner-container > .username-container > .tag,
.memo-wrapper
    > .memo-top-wrapper
    > .status-text-container
    > .status-text.public,
.page-header .title-text {
    display: none !important;
}

/* 隐藏昵称后面的 MOD 字符 */
.user-banner-container > .username-container > .tag {
    display: none !important;
}

/*隐藏 大于10行的标签 By eallion*/
.tags-wrapper > .tags-container .tag-item-container:nth-child(1n + 11) {
    display: none !important;
}

/*隐藏发布权限设置*/
.memo-editor-container > .editor-header-container > .visibility-selector {
    display: none !important;
}

/*统一标签、链接颜色为绿色*/
.memo-content-wrapper > .memo-content-text .tag-span,
.memo-content-wrapper > .memo-content-text .link {
    color: rgb(22, 163, 74) !important;
}

/*修改 blockquote 为单引号*/
.memo-content-wrapper > .memo-content-text blockquote {
    font-family: KaiTi, STKaiti, STFangsong !important;
    margin: 0 0 0 1rem !important;
    padding: 0.25rem 2rem !important;
    position: relative !important;
    border-left: 0 none !important;
}

.memo-content-wrapper > .memo-content-text blockquote::before {
    line-height: 2rem !important;
    content: "“" !important;
    font-family: Georgia, serif !important;
    font-size: 28px !important;
    font-weight: bold !important;
    position: absolute !important;
    left: 10px !important;
    top: 5px !important;
}

/*开启暗黑模式*/
@media (prefers-color-scheme: dark) {
    body {
        filter: invert(90%) hue-rotate(180deg) !important;
    }

    img,
    .icon,
    .mr-1,
    video,
    div[class*="language-"] {
        filter: invert(110%) hue-rotate(180deg) !important;
        opacity: 0.8 !important;
    }

    .memo-editor-container
        > .common-tools-wrapper
        > .btns-container
        > .confirm-btn {
        color: #000 !important;
    }
}

API:首页公告栏调用 Memos

API: https://memos.example.com/api/memo?creatorId=101&rowStatus=NORMAL&limit=10

以下代码示例,复制照搬的话不一定能用。 首先需要一个 CSS 选择器来展示 Memos,ID 命名为 memos 好了。

参考:breadcrumb-talk.html#L26-L30

<div id="memos" class=""></div>

然后用 JS 把 API 获取到的数据处理成 Json,再展示到 CSS 选择器里:

参考:footer-js.html#L63-L105

<!--引入相对时间 Lately 插件-->
<script src="//tokinx.github.io/lately/lately.min.js"></script>

<!--JS 处理 Memos API-->
<script>
    let jsonUrl =
        "https://demo.usememos.com/api/memo?creatorId=101&rowStatus=NORMAL&limit=1&offset=2" +
        "&t=" +
        Date.parse(new Date());

    fetch(jsonUrl)
        .then((res) => res.json())
        .then((resdata) => {
            var result = "",
                resultAll = "",
                data = resdata.data;
            for (var i = 0; i < data.length; i++) {
                var talkTime = new Date(
                    data[i].createdTs * 1000
                ).toLocaleString();
                var talkContent = data[i].content;
                var newtalkContent = talkContent
                    .replace(/```([\s\S]*?)```[\s]*/g, " <code>$1</code> ") //全局匹配代码块
                    .replace(/`([\s\S ]*?)`[\s]*/g, " <code>$1</code> ") //全局匹配内联代码块
                    .replace(/\!\[[\s\S]*?\]\([\s\S]*?\)/g, "?") //全局匹配图片
                    .replace(/\[[\s\S]*?\]\([\s\S]*?\)/g, "?") //全局匹配连接
                    .replace(
                        /\bhttps?:\/\/(?!\S+(?:jpe?g|png|bmp|gif|webp|jfif|gif))\S+/g,
                        "?"
                    ); //全局匹配纯文本连接
                result += `<li class="item"><span class="datetime">${talkTime}</span>: <a href="https://eallion.com/memos/">${newtalkContent}</a></li>`;
            }
            var talkDom = document.querySelector("#memos");
            var talkBefore = `<i class="iconfont icon-line-quote"></i><div class="talk-wrap"><ul class="talk-list">`;
            var talkAfter = `</ul></div>`;
            resultAll = talkBefore + result + talkAfter;
            talkDom.innerHTML = resultAll;

            // 相对时间
            window.Lately && Lately.init({ target: ".datetime" });
        });

    // 滚动效果
    setInterval(function () {
        var talkWrap = document.querySelector(".talk-list");
        var talkItem = talkWrap.querySelectorAll(".item");
        for (i = 0; i < talkItem.length; i++) {
            setTimeout(function () {
                talkWrap.appendChild(talkItem[0]);
            }, 2000);
        }
    }, 2000);
</script>

如果构建时,把 Memos 的 Json 数据保存到本地静态文件,性能还会更好。workflows.yml#L34 相对时间,用的 Lately.js 插件:footer-js.html#L91

API:嘀咕独立页面展示 Memos

DEMO: https://eallion.com/memos/ DEMO: https://memos.top/ API: https://memos.example.com/api/memo?creatorId=101&rowStatus=NORMAL&limit=10

更新:已把 Memos 剥离出一个完整的应用,可独立部署,到 eallion/memos.top 这个仓库下载部署到网站根目录即可。

  1. 放置 CSS 容器

如果是集成到自己的网站,在合适的位置需要放置一个 CSS 选择器作为展示 Memos 的容器。 大多数网站只需要在新建页面中加入这一句就可以了。

<div id="memos" class=""></div>

本站代码片段:

<div class="container">
    <h2 class="title">Memos</h2>
    <p>共嘀咕了 <span id="memosCount">0</span> 条 Memos ?</p>
    <div id="memos">
        <!-- 嘀咕加载在这里 -->
    </div>
</div>

<script type="text/javascript">
    var memos = {
        host: "https://demo.usememos.com/", //修改为自己部署 Memos 的网址,末尾有 / 斜杠
        limit: "10", //默认每次显示 10条
        creatorId: "101", //默认为 101用户 https://demo.usememos.com/u/101
        domId: "#memos", //默认为 #memos
    };
</script>

<!-- 注意替换 JS 资源文件的路径 -->
<script type="text/javascript" src="/assets/marked.min.js?v=4.2.2"></script>
<script type="text/javascript" src="/assets/pangu.min.js?v=4.0.7"></script>
<script type="text/javascript" src="/assets/moment.min.js?v=2.29.4"></script>
<script type="text/javascript" src="/assets/moment.twitter.min.js"></script>
<script type="text/javascript" src="/assets/memos.js"></script>
  1. JS 处理 API 数据
// Memos API
var memo = {
    host: "https://demo.usememos.com/",
    limit: "10",
    creatorId: "101",
    domId: "#memos",
};
if (typeof memos !== "undefined") {
    for (var key in memos) {
        if (memos[key]) {
            memo[key] = memos[key];
        }
    }
}

var limit = memo.limit;
var memos = memo.host;
var localUrl = "/memos.json";
var remoteUrl =
    memos + "api/memo?creatorId=" + memo.creatorId + "&rowStatus=NORMAL";
var page = 1,
    offset = 10,
    nextLength = 0,
    nextDom = "";
var memoDom = document.querySelector(memo.domId);
var load = '<button class="load-btn button-load">努力加载中……</button>';
if (memoDom) {
    memoDom.insertAdjacentHTML("afterend", load);
    getFirstList(); //首次加载数据
    var btn = document.querySelector("button.button-load");
    btn.addEventListener("click", function () {
        btn.textContent = "努力加载中……";
        updateHTMl(nextDom);
        if (nextLength < limit) {
            //返回数据条数小于限制条数,隐藏
            document.querySelector("button.button-load").remove();
            return;
        }
        getNextList();
    });
}

// 渲染第一页(前 10 条)
function getFirstList() {
    // 网站根目录静态文件 memos.json
    var memoUrl_first = localUrl + "?t=" + Date.parse(new Date());
    fetch(memoUrl_first)
        .then((res) => res.json())
        .then((resdata) => {
            updateHTMl(resdata.data);
            var nowLength = resdata.data.length;
            if (nowLength < limit) {
                //返回数据条数小于 limit 则直接移除“加载更多”按钮,中断预加载
                document.querySelector("button.button-load").remove();
                return;
            }
            page++;
            offset = limit * (page - 1);
            getNextList();
        });
}

//预加载下一页数据
function getNextList() {
    var memoUrl_next = remoteUrl + "&limit=" + limit + "&offset=" + offset;
    fetch(memoUrl_next)
        .then((res) => res.json())
        .then((resdata) => {
            nextDom = resdata.data;
            nextLength = nextDom.length;
            page++;
            offset = limit * (page - 1);
            if (nextLength < 1) {
                //返回数据条数为 0 ,隐藏
                document.querySelector("button.button-load").remove();
                return;
            }
        });
}

// 插入 html
function updateHTMl(data) {
    var memoResult = "",
        resultAll = "";

    const TAG_REG = /#([^\s#]+?) /g;
    const B23_REG =
        /<a href="https:\/\/b23\.tv\/([a-z|A-Z|0-9]{7})\/">.*<\/a>/g;
    const BILIBILI_REG =
        /<a href="https:\/\/www\.bilibili\.com\/video\/BV([a-z|A-Z|0-9]{10})\/">.*<\/a>/g;
    const YOUTUBE_REG =
        /<a href="https:\/\/www\.youtube\.com\/watch\?v\=([a-z|A-Z|0-9]{11})\">.*<\/a>/g;

    // Marked Options
    marked.setOptions({
        breaks: true,
        smartypants: true,
        langPrefix: "language-",
    });

    // Memos Content
    for (var i = 0; i < data.length; i++) {
        var memoContREG = data[i].content.replace(
            TAG_REG,
            "<span class='tag-span'><a target='_blank' rel='noopener noreferrer' href='https://demo.usememos.com/u/101?tag=$1'>#$1</a></span> "
        );

        memoContREG = marked
            .parse(pangu.spacing(memoContREG))
            .replace(
                BILIBILI_REG,
                "<div class='video-wrapper'><iframe src='//player.bilibili.com/player.html?bvid=$1&as_wide=1&high_quality=1&danmaku=0' scrolling='no' border='0' frameborder='no' framespacing='0' allowfullscreen='true' style='position:absolute;height:100%;width:100%;'></iframe></div>"
            )
            .replace(
                YOUTUBE_REG,
                "<div class='video-wrapper'><iframe src='https://www.youtube.com/embed/$1' title='YouTube video player' frameborder='0' allow='accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture' allowfullscreen title='YouTube Video'></iframe></div>"
            );

        //解析内置资源文件
        if (data[i].resourceList && data[i].resourceList.length > 0) {
            var resourceList = data[i].resourceList;
            var imgUrl = "",
                resUrl = "",
                resImgLength = 0;
            for (var j = 0; j < resourceList.length; j++) {
                var resType = resourceList[j].type.slice(0, 5);
                if (resType == "image") {
                    imgUrl +=
                        '<img loading="lazy" src="' +
                        memos +
                        "o/r/" +
                        resourceList[j].id +
                        "/" +
                        resourceList[j].filename +
                        '"/>';
                    resImgLength = resImgLength + 1;
                }
                if (resType !== "image") {
                    resUrl +=
                        '<a target="_blank" rel="noreferrer" href="' +
                        memos +
                        "o/r/" +
                        resourceList[j].id +
                        "/" +
                        resourceList[j].filename +
                        '">' +
                        resourceList[j].filename +
                        "</a>";
                }
            }
            if (imgUrl) {
                var resImgGrid = "";
                if (resImgLength !== 1) {
                    var resImgGrid = "grid grid-" + resImgLength;
                }
                memoContREG +=
                    '<div class="resimg ' +
                    resImgGrid +
                    '">' +
                    imgUrl +
                    "</div>";
            }
            if (resUrl) {
                memoContREG += '<p class="datasource">' + resUrl + "</p>";
            }
        }
        memoResult +=
            '<li class="timeline"><div class="talks__content"><div class="talks__text"><div class="talks__userinfo"><div>Office Demo</div><div><svg viewBox="0 0 24 24" aria-label="认证账号" class="talks__verify"><g><path d="M22.5 12.5c0-1.58-.875-2.95-2.148-3.6.154-.435.238-.905.238-1.4 0-2.21-1.71-3.998-3.818-3.998-.47 0-.92.084-1.336.25C14.818 2.415 13.51 1.5 12 1.5s-2.816.917-3.437 2.25c-.415-.165-.866-.25-1.336-.25-2.11 0-3.818 1.79-3.818 4 0 .494.083.964.237 1.4-1.272.65-2.147 2.018-2.147 3.6 0 1.495.782 2.798 1.942 3.486-.02.17-.032.34-.032.514 0 2.21 1.708 4 3.818 4 .47 0 .92-.086 1.335-.25.62 1.334 1.926 2.25 3.437 2.25 1.512 0 2.818-.916 3.437-2.25.415.163.865.248 1.336.248 2.11 0 3.818-1.79 3.818-4 0-.174-.012-.344-.033-.513 1.158-.687 1.943-1.99 1.943-3.484zm-6.616-3.334l-4.334 6.5c-.145.217-.382.334-.625.334-.143 0-.288-.04-.416-.126l-.115-.094-2.415-2.415c-.293-.293-.293-.768 0-1.06s.768-.294 1.06 0l1.77 1.767 3.825-5.74c.23-.345.696-.436 1.04-.207.346.23.44.696.21 1.04z"></path></g></svg></div><div class="talks__id">@memos</div></div><p>' +
            memoContREG +
            '</p></div><div class="talks__meta"><small class="talks__date">' +
            moment(data[i].createdTs * 1000).twitter() +
            ' • 来自「<a href="https://demo.usememos.com/m/' +
            data[i].id +
            '" target="_blank">Memos</a>」</small></div></div></li>';
    }

    var memoBefore = '<ul class="talks">';
    var memoAfter = "</ul>";
    resultAll = memoBefore + memoResult + memoAfter;
    memoDom.insertAdjacentHTML("beforeend", resultAll);
    document.querySelector("button.button-load").textContent = "加载更多";
}

源码在这里:memos.html,可能时常会更新变动。

整体样式还真是自己捏出来的,不过大多也是借鉴了 Twitter 的元素。

相对时间,用的是 Moment.js Twitter 风格的插件:memos.html#L60-L165

  • 7 天内的发布时间显示为相对时间:1 天前
  • 本年内的时间不显示年份:5月20日,13:14 • 中午
  • 去年及之前的时间显示为完整时间:2010年10月10日,10:10 • 上午

全站图片灯箱效果用的是 view-image.js插件: footer-js.html#L111-L114

API:获取 Memos 总条数

API: https://memos.example.com/api/memo/amount?creatorId=101

<span id="memosCount">0</span>
<script>
    //获取 Memos 总条数
    function getTotal() {
        var totalUrl = "https://memos.example.com/api/memo/amount?creatorId=101";
        fetch(totalUrl).then(response => {
            return response.json();
        }).then(data => {
            // console.log(data.data);
            var memosCount = document.getElementById('memosCount');
            memosCount.innerHTML = data.data;
        }).catch(err => {
            // Do something for an error here
        });
    };
    window.onload = getTotal();
</script>

Memos Awesome

一点点建议

  1. 发图尽量把图片传到第三方图床,(至少近期版本)别上传到 Memos 资源库。
  2. 附件也一样别传到 Memos 资源库,可以传到第三方网盘,贴上分享链接。
  3. 备份memos_prod.db数据库遵循两地三中心原则,多处备份,且是单向的。
  4. 如果你意识不到数据对你有多珍贵或重要,用 SaaS 服务即可,不用自建。
  5. 没有那么多人来看你的 Memos,自娱自乐即可。