基於SpringBoot從零構建部落格網站 - 整合ehcache和開發註冊登入功能

對於程式中一些字典資訊、配置資訊應該在程式啟動時載入到快取中，用時先到快取中取，如果沒有命中，再到資料庫中獲取同時放到快取中，這樣做可以減輕資料庫層的壓力。目前暫時先整合ehcache快取，同時預留了整合redis和memcached的介面。

先開發兩個最基本的功能，就是註冊和登入，對於頁面幾乎就是直接用bootstrap的風格，目前沒有過多的設計。

1、整合ehcache

在spring boot中整合ehcache還是很方便的，首先新增依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache</artifactId>
    <version>2.10.2</version>
</dependency>

新增ehcache的配置檔案，ehcache.xml，即：

<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="ehcache.xsd" 
    updateCheck="false"
    monitoring="autodetect" 
    dynamicConfig="true">

<diskStore path="java.io.tmpdir" />

<!-- 系統臨時快取（十分鐘） --> 
<cache 
    name="SystemTempCache" 
    maxEntriesLocalHeap="0"
    maxEntriesLocalDisk="10000000"
    eternal="false"
    timeToIdleSeconds="0" 
    timeToLiveSeconds="600" 
    overflowToDisk="false"
    diskPersistent="false"
    diskExpiryThreadIntervalSeconds="120"
    diskSpoolBufferSizeMB="30"
    memoryStoreEvictionPolicy="LRU">
</cache> 

<!-- 系統永久快取 --> 
<cache 
    name="SystemEternalCache" 
    maxEntriesLocalHeap="0"
    maxEntriesLocalDisk="10000000"
    eternal="true"
    overflowToDisk="false"
    diskPersistent="false"
    diskExpiryThreadIntervalSeconds="120"
    diskSpoolBufferSizeMB="30"
    memoryStoreEvictionPolicy="LRU">
</cache>

</ehcache>

其中設定了兩種快取型別，一個是臨時快取，另一個是永久快取。

此處使用快取方式不是基於註解的，雖然基於註解的方式也很方便，但是個人覺得還是自己程式控制快取好一些。

程式中會將站點的配置資訊載入到快取中，那麼使用方式如下：

（1）、首先定義一個快取介面，本程式中需要用到快取的，必須實現該介面，即：

package com.swnote.common.cache;

/**
 * 快取介面
 *
 * @author lzj
 * @since 1.0
 * @date [2019-04-27]
 */
public interface ICache<T> {
    /**
     * 根據key獲取快取資料
     *
     * @param key
     * @return
     */
    public T get(Object key);

    /**
     * 存放快取資料
     *
     * @param key
     * @param value
     */
    public void put(Object key, T value);

    /**
     * 根據key移除內容
     *
     * @param key
     */
    public void remove(Object key);
}

（2）、站點配置資訊快取ConfigCache，實現該介面，即：

package com.swnote.common.cache;

import com.swnote.common.domain.Config;
import com.swnote.common.service.IConfigService;
import com.swnote.common.util.Const;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.Cache;
import org.springframework.cache.CacheManager;
import org.springframework.context.annotation.DependsOn;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.util.List;

/**
 * 快取配置資訊
 * 配置資訊放到系統永久快取中，存放形式為："_CONFIG" + configId為key，value為配置資訊物件
 *
 * @author lzj
 * @since 1.0
 * @date [2019-04-27]
 */
@Slf4j
@DependsOn("configService")
@Component("configCache")
public class ConfigCache implements ICache<Config> {

    /**
     * 注入基於Spring提供的Cache介面例項，預設由Ehcache實現
     * TODO 以後也可以是Redis、Memcached提供實現
     */
    @Autowired
    private CacheManager cacheManager;

    @Autowired
    private IConfigService configService;

    /**
     * 系統臨時快取例項
     */
    private Cache cache;

    /**
     * key的字首
     */
    private String keyPrefix = "_CONFIG";

    @PostConstruct
    public void init() {
        // 獲取系統永久快取例項
        cache = cacheManager.getCache(Const.CACHE_SYSTEM_ETERNAL);
        log.info("獲取系統永久快取例項");

        log.info("開始載入所有配置資訊");
        List<Config> configs = configService.list();
        if (configs != null && !configs.isEmpty()) {
            configs.stream().forEach(config -> cache.put(keyPrefix + config.getConfigId(), config));
        }
        log.info("載入完畢所有配置資訊");
    }

    @Override
    public Config get(Object key) {
        Cache.ValueWrapper valueWrapper = cache.get(keyPrefix + key);
        if (valueWrapper == null) {
            // 此時從資料庫重新載入一次
            Config config = configService.getById((String) key);
            if (config == null) {
                return null;
            }

            // 再次放到快取中
            cache.put(keyPrefix + config.getConfigId(), config);

            return config;
        }
        return (Config) valueWrapper.get();
    }

    @Override
    public void put(Object key, Config value) {
        cache.put(keyPrefix + key, value);
    }

    @Override
    public void remove(Object key) {
        cache.evict(keyPrefix + key);
    }
}

2、註冊功能

註冊頁面效果如下：

頁面風格很素，這個暫時先這樣。

主要看一下UserController中處理註冊資訊的關鍵程式碼，即：

/**
 * 儲存註冊資訊
 * 
 * @param model
 * @param request
 * @return
 */
@RequestMapping(value = "/auth/signup", method = RequestMethod.POST)
@ResponseBody
public Result signup(Model model, HttpServletRequest request) {
    Result result = new Result();
    try {
        // 接收引數
        String name = request.getParameter("name");
        String email = request.getParameter("email");
        String password = request.getParameter("password");

        // 簡單校驗
        if (StringUtils.isEmpty(name) || StringUtils.isEmpty(email) || StringUtils.isEmpty(password)) {
            throw new TipException("缺少必要請求引數");
        }

        if (!StringUtil.isEmail(email)) {
            throw new TipException("郵箱不符全規範");
        }
        
        // 校驗使用者名稱
        User tempUser = userService.getByName(name);
        if (tempUser != null && !StringUtils.isEmpty(tempUser.getUserId())) {
            throw new TipException("該使用者已經註冊了");
        }
        
        // 校驗郵箱
        tempUser = userService.getByEmail(email);
        if (tempUser != null && !StringUtils.isEmpty(tempUser.getUserId())) {
            throw new TipException("該郵箱已經註冊了");
        }

        // 獲取使用者ip
        String ip = HttpUtil.getIpAddr(request);

        // 構建使用者資訊
        User user = new User();
        user.setLoginName(name);
        user.setEmail(email);
        user.setPassword(StringUtil.md5(password));
        user.setCreateIp(ip);
        
        // 儲存使用者資訊
        boolean flag = userService.create(user);
        if (!flag) {
            throw new TipException("使用者建立失敗");
        }

        result.setCode(Result.CODE_SUCCESS);
        result.setMsg("使用者建立成功");
    } catch (Exception e) {
        log.error("使用者建立失敗", e);
        result.setCode(Result.CODE_EXCEPTION);
        result.setMsg("使用者建立失敗");
    }
    return result;
}

在UserService中有一個create方法，即：

@Override
public boolean create(User user) {
    // 獲取當前時間
    Date now = new Date();

    // 設定主鍵
    user.setUserId(IdGenarator.guid());
    // 設定未實名認證
    user.setRealStatus(User.REAL_STATUS_NO);

    // 使用者是否需要啟用
    Config config = configCache.get(Const.CONFIG_USER_ACTIVE);
    if (config != null && "1".equals(config.getConfigValue())) {
        // TODO 傳送啟用郵件資訊
        // 說明需要啟用
        user.setIsActive(User.ACTIVE_NO);
    } else {
        // 說明不需要啟用，預設啟用
        user.setIsActive(User.ACTIVE_YES);
    }

    // 設定啟用賬號狀態
    user.setStatus(User.STATUS_YES);
    // 設定建立時間
    user.setCreateTime(now);
    // 設定關注數為0
    user.setFollows(0);
    // 設定粉絲數為0
    user.setFans(0);
    return save(user);
}

此處有一個還沒有實現的功能，就是傳送啟用郵件資訊，這個功能後面會補上，這裡先處於TODO狀態。

3、登入功能

登入頁面效果如下：

UserController中關鍵的程式碼如下：

/**
 * 處理登入資訊
 *
 * @param request
 * @return
 */
@RequestMapping(value = "/auth/login", method = RequestMethod.POST)
@ResponseBody
public Result login(HttpServletRequest request, HttpSession session) {
    Result result = new Result();
    try {
        // 接收引數
        String name = request.getParameter("name");
        String password = request.getParameter("password");

        if (StringUtils.isEmpty(name) || StringUtils.isEmpty(password)) {
            throw new TipException("缺少必要請求引數");
        }

        // 獲取使用者ip
        String ip = HttpUtil.getIpAddr(request);

        User user = userService.verifyUser(name, password, ip);
        if (user == null) {
            throw new TipException("使用者名稱或密碼錯誤");
        }

        // 放置session資訊
        session.setAttribute(Const.SESSION_USER, user);

        // TODO 還有一些相關統計資訊，後面再加上

        result.setCode(Result.CODE_SUCCESS);
        result.setMsg("登入成功");
    } catch (TipException e) {
        result.setCode(Result.CODE_EXCEPTION);
        result.setMsg(e.getMessage());
    } catch (Exception e) {
        log.error("登入失敗", e);
        result.setCode(Result.CODE_EXCEPTION);
        result.setMsg("登入失敗");
    }
    return result;
}

當使用者登入時，還有一些相關統計資訊，這裡由於其它功能還沒有開發完，所以獲取統計資訊的程式碼後面再加上。

關注我

以你最方便的方式關注我：
微信公眾號：