首頁手記 Springboot即時通訊開發入門教程

Springboot即時通訊開發入門教程

標簽：

SpringBoot

概述

本文详细介绍了使用Spring Boot进行即时通讯开发的基础知识，包括项目搭建、依赖管理和WebSocket集成。通过示例代码和步骤，展示了如何创建Spring Boot项目，并实现WebSocket聊天功能。此外，文章还探讨了消息持久化、用户认证与授权等内容。

Springboot即时通讯开发入门教程

Spring Boot基础介绍

Spring Boot简介

Spring Boot 是一个基于Spring框架的快速开发框架，旨在简化Spring应用的初始搭建及开发过程中的配置。通过提供一系列默认配置和starter依赖，Spring Boot使得开发者能够快速构建独立的、生产级别的应用。

创建Spring Boot项目

创建Spring Boot项目可以通过多种方式完成，最常用的方法是使用Spring Initializr。Spring Initializr是一个在线工具，可以自动生成Spring Boot项目的骨架。以下是创建Spring Boot项目的步骤：

访问Spring Initializr网站：打开浏览器，访问https://start.spring.io/。
选择项目配置：选择项目语言（Java），项目打包方式（Maven或Gradle），Spring Boot版本，以及项目信息（项目模块名、包名等）。
选择依赖：选择所需的依赖，例如Web、JPA等。
下载项目：点击“Generate”按钮，下载生成的项目压缩包。
导入项目：将下载的压缩包解压，使用IDE（如IntelliJ IDEA或Spring Tool Suite）导入项目。

示例代码

以下是在Spring Initializr中选择依赖并生成项目的基本步骤：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>im-chat</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>im-chat</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

创建主类

创建一个主启动类，用于启动Spring Boot应用：

package com.example.imchat;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ImChatApplication {
    public static void main(String[] args) {
        SpringApplication.run(ImChatApplication.class, args);
    }
}

依赖管理和配置

Spring Boot通过pom.xml文件（对于Maven项目）或build.gradle文件（对于Gradle项目）来管理项目的依赖和配置。Spring Boot的自动配置特性会根据类路径中的依赖自动配置应用。

示例代码

以下是在pom.xml中添加依赖的示例：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
</dependencies>

Spring Boot还支持外部化配置，即配置可以在application.properties或application.yml文件中定义。

示例代码

以下是一个简单的application.properties文件示例：

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/chat
spring.datasource.username=root
spring.datasource.password=root
spring.jpa.hibernate.ddl-auto=update

即时通讯基础知识

即时通讯系统概述

即时通讯系统是一种能够实现实时消息传输的系统，常见的应用场景包括即时消息发送、文件传输、语音视频通话等。即时通讯系统的架构通常包括客户端和服务端两部分。客户端负责用户界面和输入输出，服务端负责消息的转发和处理。

即时通讯的主要功能及流程

即时通讯系统的主要功能包括：

用户注册与登录：允许用户注册账号和登录系统。
消息发送与接收：用户可以发送消息，并接收其他用户的消息。
群聊功能：用户可以加入群聊并与其他群成员交流。
好友管理：用户可以添加好友、删除好友、查看好友列表等。
消息历史记录：用户可以查看过去发送或接收的消息记录。

即时通讯的主要流程包括：

用户注册/登录：用户通过注册或登录进入系统。
建立连接：客户端与服务器建立连接。
消息发送：用户发送消息，消息通过网络发送到服务器。
消息接收：服务器接收到消息后，转发给相应的接收者。
消息存储与检索：消息的存储和检索，以供后续查看。

常见即时通讯协议介绍

常见的即时通讯协议包括：

WebSocket：WebSocket是一种在单个TCP连接上进行全双工通信的协议。它使得浏览器和服务器之间的通信不再需要保持多个连接。WebSocket API使得JavaScript应用程序可以像处理传统HTTP连接一样来处理WebSocket。
XMPP：XMPP是一种基于XML的协议，用于即时通讯和网络服务。它支持客户端到服务器（C2S）、服务器到服务器（S2S）以及客户端到客户端（C2C）的消息传输。
MQTT：MQTT是一种轻量级的消息传输协议，适用于低带宽、不可靠的网络环境。它广泛应用于物联网（IoT）领域。

使用WebSocket实现即时通讯

WebSocket协议简介

WebSocket是一种在单个TCP连接上进行全双工通信的协议。它使得浏览器和服务器之间的通信不再需要保持多个连接。WebSocket API使得JavaScript应用程序可以像处理传统HTTP连接一样来处理WebSocket。

WebSocket连接的建立是通过HTTP协议进行握手的。握手完成后，就可以通过WebSocket协议进行消息的发送和接收。

在Spring Boot中集成WebSocket

在Spring Boot中集成WebSocket，可以使用Spring提供的WebSocket支持。Spring为WebSocket提供了丰富的注解和类库，帮助开发者快速集成WebSocket。

示例代码

首先，创建一个WebSocket配置类：

package com.example.imchat.websocket;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/chat").setAllowedOrigins("*");
    }
}

创建WebSocket处理器类：

package com.example.imchat.websocket;

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class MyWebSocketHandler extends TextWebSocketHandler {
    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理接收到的消息
        System.out.println("Received message: " + message.getPayload());
        // 发送消息
        session.sendMessage(new TextMessage("Echo: " + message.getPayload()));
    }
}

实现简单的聊天功能

使用WebSocket实现简单的聊天功能，可以通过创建WebSocket处理器来处理客户端发送的消息，并将消息转发给其他客户端。

示例代码

创建一个WebSocket处理器，处理连接和消息：

package com.example.imchat.websocket;

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

public class ChatWebSocketHandler extends TextWebSocketHandler {
    private static final Map<String, WebSocketSession> sessionMap = new ConcurrentHashMap<>();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessionMap.put(session.getId(), session);
        System.out.println("New connection established: " + session.getId());
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        sessionMap.remove(session.getId());
        System.out.println("Connection closed: " + session.getId());
    }

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        String payload = message.getPayload();
        System.out.println("Received message: " + payload);

        // 广播消息给所有连接的客户端
        for (WebSocketSession s : sessionMap.values()) {
            if (s.isOpen()) {
                s.sendMessage(new TextMessage("User: " + session.getId() + " says: " + payload));
            }
        }
    }
}

在WebSocket配置类中注册处理器：

package com.example.imchat.websocket;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new ChatWebSocketHandler(), "/chat").setAllowedOrigins("*");
    }
}

消息的持久化与存储

选择合适的消息存储方式

消息的持久化存储可以帮助用户查看历史消息记录。选择合适的消息存储方式需要考虑以下几个因素：

消息量：如果消息量较大，需要考虑使用数据库存储消息。
实时性：实时性要求较高的应用，可以考虑使用缓存技术，如Redis。
存储成本：存储成本也是选择方案时需要考虑的因素。

对于大多数即时通讯应用，数据库存储是一个合理的选择。

使用数据库存储消息

在Spring Boot中使用数据库存储消息，需要配置数据库连接和JPA（Java Persistence API）。

示例代码

首先，配置数据库连接：

# application.properties
spring.datasource.url=jdbc:mysql://localhost:3306/chat
spring.datasource.username=root
spring.datasource.password=root
spring.jpa.hibernate.ddl-auto=update

创建消息实体类：

package com.example.imchat.model;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Message {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    private String content;

    public Message() {}

    public Message(String username, String content) {
        this.username = username;
        this.content = content;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getContent() {
        return content;
    }

    public void setContent(String content) {
        this.content = content;
    }
}

创建消息存储仓库接口：

package com.example.imchat.repository;

import com.example.imchat.model.Message;
import org.springframework.data.jpa.repository.JpaRepository;

public interface MessageRepository extends JpaRepository<Message, Long> {}

创建消息存储服务类：

package com.example.imchat.service;

import com.example.imchat.model.Message;
import com.example.imchat.repository.MessageRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class MessageService {
    @Autowired
    private MessageRepository messageRepository;

    public void saveMessage(String username, String content) {
        messageRepository.save(new Message(username, content));
    }

    public List<Message> findAllMessages() {
        return messageRepository.findAll();
    }
}

消息的检索与分页

使用JPA可以轻松实现消息的检索和分页。

示例代码

在消息存储服务类中实现分页检索：

package com.example.imchat.service;

import com.example.imchat.model.Message;
import com.example.imchat.repository.MessageRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class MessageService {
    @Autowired
    private MessageRepository messageRepository;

    public void saveMessage(String username, String content) {
        messageRepository.save(new Message(username, content));
    }

    public List<Message> findAllMessages() {
        return messageRepository.findAll();
    }

    public Page<Message> findPaginated(int page, int size) {
        PageRequest pageRequest = PageRequest.of(page, size);
        return messageRepository.findAll(pageRequest);
    }
}

在控制器中使用分页功能：

package com.example.imchat.controller;

import com.example.imchat.model.Message;
import com.example.imchat.service.MessageService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
public class MessageController {
    @Autowired
    private MessageService messageService;

    @PostMapping("/message")
    public void sendMessage(@RequestParam String username, @RequestParam String content) {
        messageService.saveMessage(username, content);
    }

    @GetMapping("/messages")
    public List<Message> getAllMessages() {
        return messageService.findAllMessages();
    }

    @GetMapping("/messages/page")
    public Page<Message> getMessagesPage(@RequestParam int page, @RequestParam int size) {
        return messageService.findPaginated(page, size);
    }
}

用户认证与授权

常见的认证与授权机制

常见的认证与授权机制包括：

Basic认证：通过用户名和密码进行认证，简单直接。
OAuth：OAuth是一个开放标准，允许用户授权第三方应用访问其资源，而无需给出密码等敏感信息。
JWT (JSON Web Token)：JWT是一种开放标准（RFC 7519），用于在网络应用环境间安全地将信息作为JSON对象传输。

在Spring Boot中实现JWT认证

JWT是一种开放标准，用于在网络应用环境间安全地将信息作为JSON对象传输。JWT认证通常包含三个主要部分：Header、Payload和Signature。

示例代码

创建JWT工具类：

package com.example.imchat.utils;

import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class JwtTokenUtil {
    @Value("${jwt.secret}")
    private String secret;

    @Value("${jwt.expiration}")
    private Long expiration;

    public String generateToken(String username) {
        return Jwts.builder()
                .setSubject(username)
                .setIssuedAt(new Date())
                .setExpiration(new Date(System.currentTimeMillis() + expiration))
                .signWith(SignatureAlgorithm.HS512, secret)
                .compact();
    }

    public String getUsernameFromToken(String token) {
        Claims claims = Jwts.parser()
                .setSigningKey(secret)
                .parseClaimsJws(token)
                .getBody();
        return claims.getSubject();
    }

    public boolean validateToken(String token) {
        try {
            Jwts.parser().setSigningKey(secret).parseClaimsJws(token);
            return true;
        } catch (Exception e) {
            return false;
        }
    }
}

创建JWT配置类：

package com.example.imchat.security;

import com.example.imchat.utils.JwtTokenUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.web.authentication.WebAuthenticationDetailsSource;
import org.springframework.web.filter.OncePerRequestFilter;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class JwtRequestFilter extends OncePerRequestFilter {
    @Autowired
    private UserDetailsService userDetailsService;

    @Autowired
    private JwtTokenUtil jwtTokenUtil;

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
            throws ServletException, IOException {
        final String requestTokenHeader = request.getHeader("Authorization");

        String username = null;
        String jwtToken = null;
        if (requestTokenHeader != null && requestTokenHeader.startsWith("Bearer ")) {
            jwtToken = requestTokenHeader.substring(7);
            try {
                username = jwtTokenUtil.getUsernameFromToken(jwtToken);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

        if (username != null && SecurityContextHolder.getContext().getAuthentication() == null) {
            UserDetails userDetails = userDetailsService.loadUserByUsername(username);
            if (jwtTokenUtil.validateToken(jwtToken, userDetails)) {
                UsernamePasswordAuthenticationToken usernamePasswordAuthenticationToken = new UsernamePasswordAuthenticationToken(
                        userDetails, null, userDetails.getAuthorities());
                usernamePasswordAuthenticationToken
                        .setDetails(new WebAuthenticationDetailsSource().buildDetails(request));
                SecurityContextHolder.getContext().setAuthentication(usernamePasswordAuthenticationToken);
            }
        }

        chain.doFilter(request, response);
    }
}

实现用户登录与注销功能

实现用户登录和注销功能，需要创建控制器和相应的服务类。

示例代码

创建用户实体类：

package com.example.imchat.model;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    private String password;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

创建用户存储仓库接口：

package com.example.imchat.repository;

import com.example.imchat.model.User;
import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {
    User findByUsername(String username);
}

创建用户服务类：

package com.example.imchat.service;

import com.example.imchat.model.User;
import com.example.imchat.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.stereotype.Service;

@Service
public class UserService implements UserDetailsService {
    @Autowired
    private UserRepository userRepository;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        User user = userRepository.findByUsername(username);
        if (user == null) {
            throw new UsernameNotFoundException("User not found");
        }
        return new org.springframework.security.core.userdetails.User(user.getUsername(), user.getPassword(), null);
    }
}

创建登录控制器：

package com.example.imchat.controller;

import com.example.imchat.model.User;
import com.example.imchat.service.UserService;
import com.example.imchat.utils.JwtTokenUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
public class LoginController {
    @Autowired
    private UserService userService;

    @Autowired
    private JwtTokenUtil jwtTokenUtil;

    @PostMapping("/login")
    public Map<String, String> login(@RequestBody User user) {
        UserDetails userDetails = userService.loadUserByUsername(user.getUsername());
        String token = jwtTokenUtil.generateToken(userDetails.getUsername());
        Map<String, String> response = new HashMap<>();
        response.put("token", token);
        return response;
    }
}

部署与测试

构建与打包Spring Boot应用

构建Spring Boot应用可以通过Maven或Gradle工具完成。构建后的应用是一个可直接运行的jar包。

示例代码

构建项目：

mvn clean package

生成的jar文件位于target目录下。

部署应用到服务器

将构建好的jar文件部署到服务器上，可以通过多种方式完成，例如使用Docker容器化部署，或者直接将jar文件部署到服务器的指定目录。

示例代码

部署到服务器：

scp target/im-chat-0.0.1-SNAPSHOT.jar user@server:/home/user
ssh user@server
java -jar /home/user/im-chat-0.0.1-SNAPSHOT.jar

测试即时通讯功能

部署完成后，可以通过浏览器或Postman等工具测试即时通讯功能。

示例代码

测试聊天功能：

发送消息：通过WebSocket发送消息。
接收消息：通过WebSocket接收消息。
查看历史消息：通过HTTP请求查看历史消息。

测试登录功能：

登录：发送登录请求，验证是否返回有效的JWT。
使用JWT发送消息：在请求头中携带JWT，验证消息是否成功发送。

點擊查看更多內容

為 TA 點贊

若覺得本文不錯，就分享一下吧！

評論

評論

共同學習，寫下你的評論

評論加載中...

展開查看更多評論

作者其他優質文章

正在加載中

慕妹3242003

手記
篇

粉絲

9

獲贊與收藏

26

關注作者，訂閱最新文章

閱讀免費教程

后端通用面試教程

41個小節 32082 358

網絡編程入門教程

20個小節 13213 249

Pandas 入門教程

25個小節 19596 369

推薦

評論

收藏

共同學習，寫下你的評論



感謝您的支持，我會繼續努力的～

掃碼打賞，你說多少就多少

贊賞金額會直接到老師賬戶

支付方式

打開微信掃一掃，即可進行掃碼打賞哦

今天注冊有機會得

100積分直接送

付費專欄免費學

大額優惠券免費領

立即參與放棄機會

點擊
抽獎

慕課手記新用戶專享福利

恭喜你，你的運氣太好了，居然抽中了 100個積分！

恭喜你，抽中了價值元的專欄！

太棒了，直接落到你賬戶里！

積分商城里的羅技鼠標、機械鍵盤、
Kindle 閱讀器、小米平衡車
Apple iPad （10.2英寸）、大額優惠券
在等著你去兌換了噢

作者：

免費贈送

兌換碼：1111222211 復制

優惠券可用于購買實戰課、體系課
無門檻使用

先去看看，有什么好東西馬上兌換我愛學習，選課去


亚洲在线久爱草,狠狠天天香蕉网,天天搞日日干久草,伊人亚洲日本欧美

熱搜

最近搜索清空

Springboot即時通訊開發入門教程

Spring Boot简介

创建Spring Boot项目

示例代码

创建主类

依赖管理和配置

示例代码

示例代码

即时通讯系统概述

即时通讯的主要功能及流程

常见即时通讯协议介绍

WebSocket协议简介

在Spring Boot中集成WebSocket

示例代码

实现简单的聊天功能

示例代码

选择合适的消息存储方式

使用数据库存储消息

示例代码

消息的检索与分页

示例代码

常见的认证与授权机制

在Spring Boot中实现JWT认证

示例代码

实现用户登录与注销功能

示例代码

构建与打包Spring Boot应用

示例代码

部署应用到服务器

示例代码

测试即时通讯功能

示例代码

閱讀免費教程