基于SpringBoot + Vue的个人博客系统04——博客配置信息接口

客官°小女子只卖身不卖艺 2022-12-02 01:04 255阅读 0赞

## 简介 ##

一般博客信息包括，博客名称、博客描述、封面轮播图、博主头像、博主名称等等信息。

这里提供两种思路：

*  给用户提供页面表单，让用户第一次初始化博客的时候填写这些信息，然后存入数据库（这个数据表可以只有两个字段：key 和 value 专门用来存储博客配置），每次 Vue 实例创建的时候使用 created 钩子函数检查博客是否已经初始化。
 *  直接将这些信息写入配置文件，程序启动之后，后端直接加载进内存，前端需要的话就直接返回给前端。

这里为了简单，我们使用第二种方法。Hutool 工具类中有配置文件相关的工具，详情可见：https://hutool.cn/docs/\#/setting/%E8%AE%BE%E7%BD%AE%E6%96%87%E4%BB%B6-Setting

## 步骤 ##

1、新建配置文件

[]
    title = 竹林客栈
    desc = 不求风度翩翩，但求风骨立世；没有书生意气，也要为义为仁。
    covers = https://tvax1.sinaimg.cn/mw1024/bfe05ea9ly1fxgu8jys3fj21hc0u0k0j.jpg,https://tvax1.sinaimg.cn/large/bfe05ea9ly1fxgunx09dtj21hc0u0q81.jpg,https://tvax1.sinaimg.cn/large/bfe05ea9ly1fxgv2t92yyj21hc0u0qb9.jpg
    avatar = https://portrait.gitee.com/uploads/avatars/user/772/2317865_qianyucc_1589023575.png
    nickname = 竹林笔墨

说明：

*  covers 表示封面，为多个元素，可以使用英文逗号隔开，可以映射为 Java 中的List

2、新建配置文件对应的类

package pers.qianyucc.qblog.model.comm;
    
    import cn.hutool.setting.*;
    import lombok.*;
    
    import java.util.*;
    
    @Data
    public class BlogSetting { 
        private String title;
        private String desc;
        private List<String> covers;
        private String avatar;
        private String nickname;
    
        public static BlogSetting fromSetting(Setting setting){ 
            return (BlogSetting) setting.toBean(new BlogSetting());
        }
    }

3、将 setting 对象加入 Spring 的容器中

package pers.qianyucc.qblog.config;
    
    import cn.hutool.core.util.*;
    import cn.hutool.setting.*;
    import lombok.extern.slf4j.*;
    import org.springframework.beans.factory.annotation.*;
    import org.springframework.context.annotation.*;
    import pers.qianyucc.qblog.model.comm.*;
    
    import java.io.*;
    
    @Slf4j
    @Configuration
    public class BlogSettingConfig { 
        @Value("${setting.path}")
        private String settingFilePath;
    
        @Bean
        public Setting setting() { 
            File file = new File(settingFilePath);
            Setting setting;
            if (!file.exists()) { 
                setting = new Setting(file, CharsetUtil.CHARSET_UTF_8, false);
                setting.set("title", "竹林客栈");
                setting.set("desc", "不求风度翩翩，但求风骨立世；没有书生意气，也要为义为仁。");
                setting.set("covers", "https://tvax1.sinaimg.cn/mw1024/bfe05ea9ly1fxgu8jys3fj21hc0u0k0j.jpg,https://tvax1.sinaimg.cn/large/bfe05ea9ly1fxgunx09dtj21hc0u0q81.jpg,https://tvax1.sinaimg.cn/large/bfe05ea9ly1fxgv2t92yyj21hc0u0qb9.jpg");
                setting.set("avatar", "https://portrait.gitee.com/uploads/avatars/user/772/2317865_qianyucc_1589023575.png");
                setting.set("nickname", "竹林笔墨");
                setting.store(file.getAbsolutePath());
            }
            setting = new Setting(file, CharsetUtil.CHARSET_UTF_8, false);
            setting.autoLoad(true);
            log.info(BlogSetting.fromSetting(setting).toString());
            return setting;
        }
    }

说明：

*  setting.autoLoad(true); 开启自动加载，当配置文件修改的时候，不需要重启项目就可以获取到修改后的内容
 *  这里如果没有配置文件的话，我们在相应位置新建一个配置文件，并给定默认值
 *  配置文件的路径在 application-dev.yml 中配置

setting:
      path: C:/Users/Administrator/.qblog/qblog.setting

4、新建`CommService`，并编写获取博客信息的方法

package pers.qianyucc.qblog.service;
    
    import cn.hutool.core.convert.*;
    import cn.hutool.setting.*;
    import com.baomidou.mybatisplus.core.conditions.query.*;
    import org.springframework.beans.factory.annotation.*;
    import org.springframework.stereotype.*;
    import pers.qianyucc.qblog.dao.*;
    import pers.qianyucc.qblog.model.comm.*;
    import pers.qianyucc.qblog.model.entity.*;
    import pers.qianyucc.qblog.model.vo.*;
    
    import java.util.*;
    
    @Service
    public class CommService { 
        @Autowired
        private ArticleMapper articleMapper;
        @Autowired
        private Setting setting;
    
        public BlogInfoVO getBlogInfo() { 
            BlogSetting blogSetting = BlogSetting.fromSetting(setting);
            BlogInfoVO vo = BlogInfoVO.fromBlogSetting(blogSetting);
            QueryWrapper<ArticlePO> wrapper = new QueryWrapper<>();
            wrapper.select("sum(views) as total_views");
            List<Map<String, Object>> maps = articleMapper.selectMaps(wrapper);
            int totalViews = 0;
            if (!maps.isEmpty()) { 
                totalViews = Convert.toInt(maps.get(0).get("total_views"), 0);
            }
            Integer articleCount = articleMapper.selectCount(null);
            vo.setTotalViews(totalViews);
            vo.setArticleCount(articleCount);
            return vo;
        }
    }

5、在 `CommController` 中添加获取配置信息的 api

@ApiOperation("获取博客信息")
    @GetMapping("/info")
    public Results<BlogInfoVO> info() { 
        BlogInfoVO blogInfo = commService.getBlogInfo();
        return Results.ok(blogInfo);
    }

6、最后算是修复以前的一个小 bug ，在 ArticleService 中，修改 findById 方法，添加浏览量加一的功能

@Transactional(rollbackFor = Exception.class)
    public ArticleVO findById(String id) { 
        ArticlePO articlePO = articleMapper.selectById(id);
        if (Objects.isNull(articlePO)) { 
            throw new BlogException(INVALID_ID);
        }
        articlePO.setViews(articlePO.getViews() + 1);
        articleMapper.updateById(articlePO);
        return ArticleVO.fromArticlePO(articlePO);
    }

7、在Swagger中测试

![测试获取博客信息接口][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpMzQ1NTI3NzkyNQ_size_16_color_FFFFFF_t_70_pic_center]

当修改配置文件之后在进行测试：

![修改配置文件][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpMzQ1NTI3NzkyNQ_size_16_color_FFFFFF_t_70_pic_center 1]

对应接口数据也已经更新

![对应接口数据也已经更新][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpMzQ1NTI3NzkyNQ_size_16_color_FFFFFF_t_70_pic_center 2]

参考代码：https://gitee.com/qianyucc/QBlog2/tree/v-6.0

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpMzQ1NTI3NzkyNQ_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/9b7f0d4bd2244750888fa3ac2eb4fb02.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpMzQ1NTI3NzkyNQ_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/f890b6fe02c84a0988e9aab9ff6eedf9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpMzQ1NTI3NzkyNQ_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/b482bdbb617e42338a4baf6f057d01f3.png