• 项目实战——匹配系统(上)


    ps:从这篇文章开始,整个项目最精华(困难)的部分就要来了,因此这里会把每一个步骤细分,并且说一下自己对于每个步骤的思考和理解(博主水平有限,错误在所难免,欢迎指出讨论)

    目录

    一、什么是匹配系统

    二、WebSocket协议

    三、在云端维护游戏的整个过程 

    四、引入WebSocket

    五、 实现从后端向前端发信息

    六、 前端调试

    七、加上jwt验证

    八、 实现前端页面

    九、解决同步问题


    一、什么是匹配系统

    匹配系统就是一个单独的程序就类似于MySQL
    生成地图的过程在用户本地、两名玩家在本地实现地图
    地图就大概率不一样、需要将生成地图过程放在服务器中
    Game任务需要生成统一的地图、Game第一步先生成一个地图CreateMap
    有很多逻辑都需要在服务器端完成、判断蛇输赢的逻辑
    当我们撞的时候死亡、如果在客户端用户本地就可以作弊
    所以说我们整个游戏的过程应该都放到服务器端、不止生成地图这个过程
    同时蛇的移动、蛇的判定、都要在服务器端统一完成
    服务器端判断完之后再把结果返还给前端、前端只是用来花动画的
    前端不做任何判定逻辑、并不是所有的游戏判定逻辑都在云端
    回合制通信量比较少、比如吃鸡各种fps游戏在本地操作非常频繁
    如果都在云端的话延迟会非常高、判断是否击中对方的逻辑判断就是在本地
    所以要在游戏体验在用户作弊之间做一个权衡、锁头挂之类的
    炉石所有逻辑判断都在云端、很难作弊
    整个我们在云端维护游戏过程它的整个流程

     

    要实现匹配系统起码要有两个客户端client1,client2,当客户端打开对战页面并开始匹配时,会给后端服务器server发送一个请求,而匹配是一个异步的过程,什么时候返回结果是不可预知的,所以我们要写一个专门的匹配系统,维护一堆用户的集合,当用户发起匹配请求时,请求会先传给后端服务器,然后再传给匹配系统处理,匹配系统会不断地在用户里去筛选,将rating较为相近的的用户匹配到一组。当成功匹配后,匹配系统就会返回结果给springboot的后端服务器,继而返回给客户端即前端。然后我们就能在前端看到匹配到的对手是谁啦。

    举个例子,两个客户端请求两个链接,新建两个类:

    1. public class WebSocketServer {
    2. @OnOpen
    3. public void onOpen(Session session, @PathParam("token") String token) {
    4. // 建立连接
    5. WebSocketServer client1 = new WebSocketServer();
    6. WebSocketServer client2 = new WebSocketServer();
    7. }
    8. @OnClose
    9. public void onClose() {
    10. // 关闭链接
    11. }
    12. @OnMessage
    13. public void onMessage(String message, Session session) {
    14. // 从Client接收消息
    15. }
    16. @OnError
    17. public void onError(Session session, Throwable error) {
    18. error.printStackTrace();
    19. }
    20. }

     

    二、WebSocket协议

    因为匹配是异步的过程,且需要前后端双向交互,而普通的http协议是单向的,一问一答式的,属于立即返回结果的类型,不能满足我们的异步需求,因此我们需要一个新的协议websocket:不仅客户端可以主动向服务器端发送请求,服务器端也可以主动向客户端发送请求,是双向双通的,且支持异步。简单来说就是客户端向后端发送请求,经过不确定的时间,会返回一次或多次结果给客户端。
    基本原理: 每一个ws连接都会在后端维护起来,客户端连接服务器的时候会创建一个WebSocketServer类。每创建一个链接就是new一个WebSocketServer类的实例,所有与链接相关的信息,都会存在这个类里面。

    703f1a598b1cfe5b132599c137.jpg

    三、在云端维护游戏的整个过程 

    由于每次刷新都会刷新不同的地图,为了公平起见,应该把地图的生成放在服务器端,然后返回结果给前端。
    为了防止作弊,游戏的一系列操作、判断逻辑都应该放在服务器端,前端只是呈现动画。
    我们可以从客户端获取输入,也可以通过微服务从代码端获得输入。
    简单的流程如下: Game -> Create map -> 返回给客户端 -> 客户端等待匹配waiting (sleep) -> 匹配成功则进行一系列游戏逻辑

    四、引入WebSocket

    在pom.xml文件中添加依赖:

    spring-boot-starter-websocket
    fastjson

    1. <dependency>
    2. <groupId>org.springframework.bootgroupId>
    3. <artifactId>spring-boot-starter-websocketartifactId>
    4. <version>2.7.2version>
    5. dependency>
    6. <dependency>
    7. <groupId>com.alibabagroupId>
    8. <artifactId>fastjsonartifactId>
    9. <version>2.0.11version>
    10. dependency>

     添加config/WebSocketConfig配置类:

    1. import org.springframework.context.annotation.Bean;
    2. import org.springframework.context.annotation.Configuration;
    3. import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    4. @Configuration
    5. public class WebSocketConfig {
    6. @Bean
    7. public ServerEndpointExporter serverEndpointExporter() {
    8. return new ServerEndpointExporter();
    9. }
    10. }

     添加consumer/WebSocketServer类

    1. package com.popgame.backend.consumer;
    2. import org.springframework.stereotype.Component;
    3. import javax.websocket.*;
    4. import javax.websocket.server.PathParam;
    5. import javax.websocket.server.ServerEndpoint;
    6. @Component
    7. @ServerEndpoint("/websocket/{token}") // 注意不要以'/'结尾
    8. public class WebSocketServer {
    9. @OnOpen
    10. public void onOpen(Session session, @PathParam("token") String token) {
    11. // 建立连接
    12. }
    13. @OnClose
    14. public void onClose() {
    15. // 关闭链接
    16. }
    17. @OnMessage
    18. public void onMessage(String message, Session session) {
    19. // 从Client接收消息
    20. }
    21. @OnError
    22. public void onError(Session session, Throwable error) {
    23. error.printStackTrace();
    24. }
    25. }

    五、 实现从后端向前端发信息

    从后端向前端怎么发信息、需要自己实现一下
    首先用websocket的一个api、建立链接的时候需要把session存下来
    如何从后端向前端发信息呢、写一个辅助函数,异步通信需要加一个锁
    异步通信需要加一个锁、我们要知道这个链接对应的是谁
    才知道谁跟谁匹配到一块了,另外我们还需要存储一下所有链接
    因为当我们接收到一个信息之后,比如当我们从匹配系统接收到某一局匹配成功的信息之后
    我们需要将这个消息发送给匹配成功的两名玩家、我们需要能够根据用户的id找到它对
    应的链接是谁,才可以利用这个链接向前端发请求,所以对于所有的websocket可见的一个全局变量
    用来存储所有的链接、对于所有的实列可见定义为静态变量
    由于每个实例在每个线程里面,所以公共的变量是线程安全的用线程安全的哈希表
    将userid映射到我们的websocket实例

    需要注意的是:WebSocketServer并不是一个标准的Springboot的组件,不是一个单例模式(每一个类同一时间只能有一个实例,这里每建一个链接都会new一个类,所以不是单例模式),向里面注入数据库并不像在Controller里一样直接@Autowired,要改成先定义一个static变量,再@Autowired加入到setUsersMapper函数上,如下:

    1. private static UsersMapper usersMapper;
    2. @Autowired
    3. public void setUsersMapper(UsersMapper usersMapper) {
    4. WebSocketServer.usersMapper = usersMapper; //静态变量访问要用类名访问
    5. }

     @Autowired写在set()方法上,在spring会根据方法的参数类型从ioc容器中找到该类型的Bean对象注入到方法的行参中,并且自动反射调用该方法(被@Autowired修饰的方法一定会执行),所以一般使用在set方法中、普通方法不用。

    当我们建立链接的时候我们需要从token中读取当前的用户是谁,
    有了id之后去插数据库去查id是谁,查数据库注入userMapper
    静态变量相当于是所有实例的一个全局变量,
    如果不加静态变量的话那就是所有的实列所有独有一份,哈希表是对所有的实例都可见
    每一个实例都要访问同一个哈希表,不加static 相当于局部变量
    websocketserver,并不是一个标准的spring里的组件,注入的时候跟controller是有所区别的
    静态变量访问的时候需要用类名访问

    consumer/WebSocketServer.java:

    1. package com.popgame.backend.consumer;
    2. import com.popgame.backend.mapper.UsersMapper;
    3. import com.popgame.backend.pojo.Users;
    4. import org.springframework.beans.factory.annotation.Autowired;
    5. import org.springframework.stereotype.Component;
    6. import javax.websocket.*;
    7. import javax.websocket.server.PathParam;
    8. import javax.websocket.server.ServerEndpoint;
    9. import java.io.IOException;
    10. import java.util.concurrent.ConcurrentHashMap;
    11. @Component
    12. @ServerEndpoint("/websocket/{token}") // 注意不要以'/'结尾
    13. public class WebSocketServer {
    14. //与线程安全有关的哈希表,将userID映射到相应用户的WebSocketServer
    15. private static ConcurrentHashMap users = new ConcurrentHashMap<>();
    16. //当前链接请求的用户
    17. private Users user;
    18. //后端向前端发信息,每个链接用session维护
    19. private Session session = null;
    20. private static UsersMapper usersMapper;
    21. @Autowired
    22. public void setUsersMapper(UsersMapper usersMapper) {
    23. WebSocketServer.usersMapper = usersMapper; //静态变量访问要用类名访问
    24. }
    25. @OnOpen
    26. public void onOpen(Session session, @PathParam("token") String token) {
    27. // 建立连接
    28. System.out.println("connected!");
    29. this.session = session;
    30. //为了方便调试,初阶段只把token当成userId看
    31. Integer userId = Integer.parseInt(token);
    32. this.user = usersMapper.selectById(userId);
    33. users.put(userId, this);
    34. }
    35. @OnClose
    36. public void onClose() {
    37. // 关闭链接
    38. System.out.println("disconnected!");
    39. //断开连接的话要将user移除
    40. if (this.user != null) {
    41. users.remove((this.user.getId()));
    42. }
    43. }
    44. @OnMessage
    45. public void onMessage(String message, Session session) {
    46. // 从Client接收消息
    47. System.out.println("receive message!");
    48. }
    49. @OnError
    50. public void onError(Session session, Throwable error) {
    51. error.printStackTrace();
    52. }
    53. //后端向前端发信息
    54. private void sendMessage(String message) {
    55. //异步通信要加上锁
    56. synchronized (this.session) {
    57. try {
    58. this.session.getBasicRemote().sendText(message);
    59. } catch (IOException e) {
    60. e.printStackTrace();
    61. }
    62. }
    63. }
    64. }

    放行websocket连接

    配置config/SecurityConfig

    1. @Override
    2. public void configure(WebSecurity web) throws Exception {
    3. web.ignoring().antMatchers("/websocket/**");
    4. }

     

    六、 前端调试

    配置config.SecurityConfig、然后去前端写一写调试一下整个过程
    放行这一类所有链接、创建一个从后端到前端建立一个链接
    需要当我们的组件加载出来的时候建立一个链接
    把周期函数取出来、另外我们可以将socket存到另外一个变量里面
    当当前组件被挂载的时候,我们需要创建一个链接

    onMounted: 当组件被挂载的时候执行的函数
    onUnmonted: 当组件被卸载的时候执行的函数
    初步调试阶段,我们是将token传进user.id的

    store/pk.js:

    将pk引入store中

    store/index.js

    1. import ModuleUser from './user'
    2. export default {
    3. state: {
    4. socket: null, //ws链接
    5. opponent_username: "",
    6. opponent_photo: "",
    7. status: "matching", //matching表示匹配界面,playing表示对战界面
    8. },
    9. getters: {
    10. },
    11. mutations: {
    12. updateSocket(state,socket) {
    13. state.socket = socket;
    14. },
    15. updateOpponent(state,opponent) {
    16. state.opponent_username = opponent.username;
    17. state.opponent_photo = opponent.photo;
    18. },
    19. updateStatus(state,status) {
    20. state.status = status;
    21. }
    22. },
    23. actions: {
    24. },
    25. modules: {
    26. user: ModuleUser,
    27. }
    28. }

    将pk引入store中

    store/index.js

    1. import { createStore } from 'vuex'
    2. import ModuleUser from './user'
    3. import ModulePk from './pk'
    4. export default createStore({
    5. state: {
    6. },
    7. getters: {
    8. },
    9. mutations: {
    10. },
    11. actions: {
    12. },
    13. modules: {
    14. user: ModuleUser,
    15. pk: ModulePk,
    16. }
    17. })

     前端与后端建立连接
    views/pk/PKIndex.vue

    1. <script>
    2. //import ContentBase from "@/components/ContentBase.vue"
    3. import PlayGround from "@/components/PlayGround.vue"
    4. import { onMounted, onUnmounted } from "vue";
    5. import { useStore } from "vuex"
    6. export default {
    7. name: "PKindex",
    8. components: {
    9. // ContentBase,
    10. PlayGround,
    11. },
    12. setup() {
    13. const store = useStore();
    14. //字符串中有${}表达式操作的话要用``,不能用引号
    15. const socketUrl = `ws://127.0.0.1:3000/websocket/${store.state.user.id}/`;
    16. let socket = null;
    17. onMounted(() => { //当当前页面打开时调用
    18. socket = new WebSocket(socketUrl); //js自带的WebSocket()
    19. socket.onopen = () => { //连接成功时调用的函数
    20. console.log("connected!");
    21. store.commit("updateSocket",socket);
    22. }
    23. socket.onmessage = msg => { //前端接收到信息时调用的函数
    24. const data = JSON.parse(msg.data); //不同的框架数据定义的格式不一样
    25. console.log(data);
    26. }
    27. socket.onclose = () => { //关闭时调用的函数
    28. console.log("disconnected!");
    29. }
    30. });
    31. onUnmounted(() => { //当当前页面关闭时调用
    32. socket.close(); //卸载的时候断开连接
    33. });
    34. }
    35. }
    36. script>
    37. <style scoped>
    38. style>

     

    七、加上jwt验证

    我们现在建立链接的时候、直接把用户id传过来就可以建立链接了
    这样就可以实现一个身份的验证、如果可以正常解析出来的话就表示登录成功

    const socketUrl = `ws://127.0.0.1:3000/websocket/${store.state.user.token}/`;

    添加ws的jwt验证,根据token判断用户是否存在

    consumer/utils/JwtAuthenciation.java

    1. package com.popgame.backend.consumer.utils;
    2. import com.popgame.backend.utils.JwtUtil;
    3. import io.jsonwebtoken.Claims;
    4. public class JwtAuthentication {
    5. public static Integer getUserId(String token) {
    6. int userId = -1; //-1表示不存在
    7. try {
    8. Claims claims = JwtUtil.parseJWT(token);
    9. userId = Integer.parseInt(claims.getSubject());
    10. } catch (Exception e) {
    11. throw new RuntimeException(e);
    12. }
    13. return userId;
    14. }
    15. }

     修改后端
    consumer/WebSocketServer.java

    1. 如果可以正常解析出jwt token的话表示登录成功,否则登录不成功,直接close
    2. ...
    3. @OnOpen
    4. public void onOpen(Session session, @PathParam("token") String token) throws IOException {
    5. // 建立连接
    6. System.out.println("connected!");
    7. this.session = session;
    8. Integer userId = JwtAuthentication.getUserId(token);
    9. this.user = usersMapper.selectById(userId);
    10. if (this.user != null) {
    11. users.put(userId, this);
    12. } else {
    13. this.session.close();
    14. }
    15. }
    16. ...

    八、 实现前端页面

    当前只有对战界面木有匹配界面、所以我们还需要实现一个匹配界面
    实现切换、类似于roter,实现匹配界面

    views/pk/PKindex.vue

    1. <template>
    2. <PlayGround v-if="$store.state.pk.status === 'playing'" />
    3. <MatchGround v-if="$store.state.pk.status === 'matching'" />
    4. template>

     用grid系统布局自己头像:对手头像= 6 : 6
    逻辑很简单,只要点击匹配按钮,就向后端发送请求开始匹配。
    components/MatchGround.vue

    1. <template>
    2. <div class="matchGround">
    3. <div class="row">
    4. <div class="col-6">
    5. <div class="user-photo">
    6. <img :src="$store.state.user.photo" alt="">
    7. div>
    8. <div class="user-username">
    9. {{ $store.state.user.username }}
    10. div>
    11. div>
    12. <div class="col-6">
    13. <div class="user-photo">
    14. <img :src="$store.state.pk.opponent_photo" alt="">
    15. div>
    16. <div class="user-username">
    17. {{ $store.state.pk.opponent_username }}
    18. div>
    19. div>
    20. <div class="col-12" style="padding-top: 15vh;">
    21. <button @click="click_match_btn" type="button" class="btn match-btn">{{ match_btn_info }}button>
    22. div>
    23. div>
    24. div>
    25. template>

     前端向后端发送请求:store.state.pk.socket.send(字符串);
    以开始匹配为例:

    1. store.state.pk.socket.send(JSON.stringify({
    2. event: "start matching",
    3. }));

     后端可以在onMessage那里接收到前端的请求,并且解析传送过来的数据
    consumer/WebSocketServer.java

    1. @OnMessage
    2. public void onMessage(String message, Session session) {
    3. // 从Client接收消息
    4. System.out.println("receive message!");
    5. JSONObject data = JSONObject.parseObject(message);
    6. String event = data.getAsString("event");
    7. if ("start matching".equals(event)) {
    8. startMatching();
    9. } else if ("stop matching".equals(event)) {
    10. stopMatching();
    11. }
    12. }

     用线程安全的set定义匹配池:final private static CopyOnWriteArraySet matchPoll = new CopyOnWriteArraySet<>();
    开始匹配时,将用户放进拼配池里,取消匹配时将用户移除匹配池
    匹配过程在目前调试阶段可以简单地两两匹配

    1. private void startMatching() {
    2. System.out.println("start mathcing!");
    3. matchPoll.add(this.user);
    4. while (matchPoll.size() >= 2) {
    5. Iterator it = matchPoll.iterator(); //枚举
    6. Users a = it.next(), b = it.next();
    7. matchPoll.remove(a);
    8. matchPoll.remove(b);
    9. JSONObject respA = new JSONObject();
    10. respA.put("event", "start-matching");
    11. respA.put("opponent_username", b.getUsername());
    12. respA.put("opponent_photo", b.getPhoto());
    13. //用users获取a的链接
    14. users.get(a.getId()).sendMessage(respA.toJSONString()); //用这个链接将信息传回给前端
    15. JSONObject respB = new JSONObject();
    16. respB.put("event", "start-matching");
    17. respB.put("opponent_username", a.getUsername());
    18. respB.put("opponent_photo", a.getPhoto());
    19. //用users获取b的链接
    20. users.get(b.getId()).sendMessage(respB.toJSONString()); //用这个链接将信息传回给前端
    21. }
    22. }
    23. private void stopMatching() {
    24. System.out.println("stop matching!");
    25. matchPoll.remove(this.user);
    26. }

     后端返回信息给前端后,在前端接受并处理信息
    views/PKindex.vue

    1. ...
    2. socket.onmessage = msg => { //前端接收到信息时调用的函数
    3. const data = JSON.parse(msg.data); //不同的框架数据定义的格式不一样
    4. if (data.event === "start-matching") { //这个这个start-matching是respA或respB返回的
    5. //匹配成功,更新对手信息
    6. store.commit("updateOpponent",{
    7. username: data.opponent_username,
    8. photo: data.opponent_photo,
    9. });
    10. }
    11. }
    12. ...

     这样,我们就能初步实现匹配系统了。
    匹配成功2s后跳到pk页面,只需要updateStatus即可
    注意的是卸载组件的时候要记得把状态改为matching
    views/PK/PKindex.vue

    1. ...
    2. socket.onmessage = msg => { //前端接收到信息时调用的函数
    3. ....
    4. if (data.event === "start-matching") {
    5. ...
    6. setTimeout(() => {
    7. store.commit("updateStatus", "playing");
    8. },2000); //延时函数,单位是毫秒
    9. }
    10. }
    11. socket.onclose = () => { //关闭时调用的函数
    12. console.log("disconnected!");
    13. store.commit("updateStatus", "matching");
    14. }
    15. ...
    16. ...

    九、解决同步问题

    前文也提到过,生成地图,游戏逻辑等与游戏相关的操作都应该放在服务端,不然的话客户每次刷新得到的地图都不一样,游戏的公平性也不能得到保证。因此,我们要将之前在前端写的游戏逻辑全部转移到后端(云端),前端只负责动画的演示即可。

    后端实现
    首先要在后端创建一个Game类实现游戏流程,其实就是把之前在前端写的js全部翻译成Java就好了
    consumer/utils/Game.java
    直接按照之前的gamemap.js搬过去就好了,代码太长这里就不贴了
    然后我们在WebSocketServer.java里面调用一下
    现阶段直接在局部调用作为调试

    1. private void startMatching() {
    2. ...
    3. while (matchPoll.size() >= 2) {
    4. ...
    5. respA.put("game_map", game.getMark());
    6. ...
    7. respB.put("game_map", game.getMark());
    8. }
    9. }

     修改前端
    首先在store/pk.js里添加game_map变量存下地图

    1. state: {
    2. ...
    3. game_map: null,
    4. },

    添加更新函数

    1. mutations: {
    2. ...
    3. updateGameMap(state, game_map) {
    4. state.game_map = game_map;
    5. },
    6. },

     其次,修改scripts/GameMap.js,即我们之前在前端生成地图的地方,把生成地图一系列步骤可以删掉了

    最后再在views/PK/PKindex.vue里接受后端传来的数据并更新地图就好了。

    1. socket.onmessage = msg => { //前端接收到信息时调用的函数
    2. const data = JSON.parse(msg.data); //不同的框架数据定义的格式不一样
    3. ...
    4. setTimeout(() => {
    5. store.commit("updateStatus", "playing");
    6. },2000);
    7. store.commit("updateGameMap",data.game_map);
    8. }
    9. }

    由于这节课难度确实有所提升,整篇文章可能无法做到向之前的条理清晰,请大家多多海涵,因为要实现的东西实在太多了,详情请见git 

    kob: springBoot 究极项目 (gitee.com)icon-default.png?t=M85Bhttps://gitee.com/geng-chaoyang-11/kob

  • 相关阅读:
    Stream流处理快速上手最佳实践 | 京东物流技术团队
    定岗定编设计:企业职能部门定岗定编设计项目成功案例
    基于Nodejs的心理咨询微信小程序的设计和实现
    [数据集][VOC]高质量的目标检测数据集合集(持续更新)
    sql调优
    C语言结构体中成员的引用
    WinUI(WASDK)使用MediaPipe检查人体姿态关键点
    二叉树 | 迭代遍历 | leecode刷题笔记
    事务回调编程
    heapdump泄露Shiro key从而RCE
  • 原文地址:https://blog.csdn.net/qq_59539549/article/details/127988553