WeChatログインのバックエンド

📢 この記事は gemini-2.5-flash によって翻訳されました

旧正月おめでとう！

流れはここを見てね： https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html

フロントエンドで認証コードを取得したら、 https://api.weixin.qq.com/sns/jscode2session にリクエストを送って、session_keyとopenidを手に入れるんだ。

WeChatのリクエストAPIはこちら： https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/code2Session.html

分析と設計

API設計

リクエストパス：/user/user/login

リクエストメソッド：POST

リクエストパラメータ：code String (WeChatユーザーの認証コード)

返却データ：

id integer (ユーザーID)
openid (WeChat openid)
token (JWTトークン)

データベーステーブル設計

ユーザーがミニプログラムを初めて使うと自動的に登録されて、関連情報がuserテーブルに保存されるよ。

フィールド名	データ型	説明
id	bigint	主キー、自動インクリメント
openid	varchar(45)	WeChatユーザーのユニークな識別子
name	varchar(32)	ユーザー名
phone	varchar(11)	電話番号
gender	varchar(2)	性別
id_number	varchar(18)	身分証明書番号
avatar	varchar(500)	WeChatユーザーのアバターパス
create_time	datetime	登録時間

個人の身分で登録したミニプログラムだと、WeChatユーザーの電話番号は取得できないからね。

プログラム設定

まずはWeChatログインに必要なパラメータを設定するよ。

application-dev.yml

1
2
3
4
sky:
  wechat:
    appid: your_appid
    secret: your_secret

application.yml

1
2
3
4
sky:
  wechat:
    appid: ${sky.wechat.appid}
    secret: ${sky.wechat.secret}

WeChatユーザーにJWTトークンを生成する際に使う設定項目だよ。

1
2
3
4
5
6
sky:
  jwt:
    # ユーザー関連
    user-secret-key: key
    user-ttl: 7200000
    user-token-name: authentication

Java

ビジネスロジックコード

controller

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
@RestController
@RequestMapping("/user/user")
@Api(tags = "ユーザー関連API")
@Slf4j
public class UserController {
    @Autowired
    private UserService userService;
    @Autowired
    private JwtProperties jwtProperties;

    @PostMapping("/login")
    @ApiOperation("WeChatログイン")
    public Result<UserLoginVO> login(@RequestBody UserLoginDTO userLoginDTO){
        log.info("WeChatユーザーログイン：{}", userLoginDTO.getCode());

        // WeChatログイン
        User user = userService.wxlogin(userLoginDTO);

        // WeChatユーザーのためにJWTトークンを生成する
        HashMap<String, Object> claims = new HashMap<>();
        claims.put(JwtClaimsConstant.USER_ID, user.getId());
        String token = JwtUtil.createJWT(jwtProperties.getUserSecretKey(),
                jwtProperties.getUserTtl(), claims);

        UserLoginVO userLoginVO = UserLoginVO.builder()
                .id(user.getId())
                .openid(user.getOpenid())
                .token(token)
                .build();

        return Result.success(userLoginVO);
    }
}

service

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@Service
@Slf4j
public class UserServiceImpl implements UserService {
    // WeChat API
    public static final String WX_LOGIN = "https://api.weixin.qq.com/sns/jscode2session";

    @Autowired
    private WeChatProperties weChatProperties;
    @Autowired
    private UserMapper userMapper;

    @Override
    public User wxlogin(UserLoginDTO userLoginDTO) {
        String openid = getOpenid(userLoginDTO.getCode());

        // openidが有効かどうかのチェック
        if (openid == null){
            throw new LoginFailedException(MessageConstant.LOGIN_FAILED);
        }

        // 新しいユーザーかどうかをチェック
        User user = userMapper.getByOpenid(openid);
        // もし新しいユーザーだったら、自動的に登録する
        if (user == null){
            user = User.builder()
                    .openid(openid)
                    .createTime(LocalDateTime.now())
                    .build();
            userMapper.insert(user);
        }
        return user;
    }

    // WeChat APIを呼び出して、ユーザーのopenidを取得する
    private String getOpenid(String code){
        Map<String,String> map = new HashMap<>();
        map.put("appid", weChatProperties.getAppid());
        map.put("secret", weChatProperties.getSecret());
        map.put("js_code", code);
        map.put("grant_type", "authorization_code");

        String json = HttpClientUtil.doGet(WX_LOGIN, map);

        JSONObject jsonObject = JSON.parseObject(json);
        String openid = jsonObject.getString("openid");
        return openid;
    }
}

Mapper

1
2
3
4
5
6
7
@Mapper
public interface UserMapper {
    @Select("select * from user where openid = #{openid}")
    User getByOpenid(String openid);

    void insert(User user);
}

Mapper XML

1
2
3
4
5
6
7
8
9
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.sky.mapper.UserMapper">
    <insert id="insert">
        insert into user(openid, name, phone, sex, id_number, avatar, create_time)
        VALUES (#{openid}, #{name}, #{phone}, #{sex}, #{idNumber}, #{avatar}, #{createTime})
    </insert>
</mapper>

インターセプター

ユーザーからのリクエストを一括でインターセプトして、JWTの検証を行うよ。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@Component
@Slf4j
public class JwtTokenUserInterceptor implements HandlerInterceptor {
    @Autowired
    private JwtProperties jwtProperties;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // インターセプトのタイプがコントローラーなのか、他のリソースなのかを判断する
        if(!(handler instanceof HandlerMethod)){
            // 現在のインターセプトが動的メソッドじゃない場合、そのまま通す
            return true;
        }

        // リクエストからトークンを取得する
        String token = request.getHeader(jwtProperties.getUserTokenName());
        // トークンの検証
        try {
            log.info("JWT検証：{}", token);
            Claims claims = JwtUtil.parseJWT(jwtProperties.getUserSecretKey(), token);
            Long userId = Long.valueOf(claims.get(JwtClaimsConstant.USER_ID).toString());
            log.info("現在のユーザーID：{}", userId);
            BaseContext.setCurrentId(userId);
            // 検証成功
            return true;
        }catch (Exception ex){
            // 検証失敗
            return false;
        }
    }
}

WebMvcConfigurationにインターセプターを登録する

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    @Autowired
    private JwtTokenUserInterceptor jwtTokenUserInterceptor;
    /**
     * カスタムインターセプターを登録する
     * @param registry
     */
    protected void addInterceptors(InterceptorRegistry registry) {
        log.info("カスタムインターセプターの登録を開始するよ...");
        //.........

        registry.addInterceptor(jwtTokenUserInterceptor)
                .addPathPatterns("/user/**")
                .excludePathPatterns("/user/user/login")
                .excludePathPatterns("/user/shop/status");
    }