How ngo-son-truong/spring-boot-webrtc works
Project type and purpose
• This is a full-stack, single-module Spring Boot web application that provides real-time, peer-to-peer video/audio calls using WebRTC.
• The frontend is server-rendered with Thymeleaf and Bootstrap, enhanced by JavaScript for WebRTC and WebSocket signaling.
• The backend exposes:
• HTTP endpoints for page rendering and authentication (AuthController, VideoCallController)
• A STOMP-over-SockJS WebSocket endpoint for signaling (WebRTCSignalController)
File structure
• Top-level: pom.xml, Maven wrapper, README
• src/main/java/com/project/webrtc
• config: WebMvcConfig, WebSocketConfig, AuthInterceptor
• controller: AuthController, VideoCallController, WebRTCSignalController
• service: RoomService, UserService
• model: User, Room, WebRTCMessage
• WebRtcApplication.java (Spring Boot entry point)
• src/main/resources
• application.yml (configuration)
• static/css (styles.css)
• templates (index.html, login, register, room)
• No external database folder—services likely use in-memory or simple persistence.
Key architecture points from README
• Signaling via WebSocket (STOMP over SockJS)
• P2P media uses WebRTC APIs (with STUN; TURN optional)
• Multi-user rooms, screen sharing, camera switching
Main components
a. Clients (Browsers)
• UI: Thymeleaf-rendered pages + Bootstrap + custom JS
• WebSocket client (SockJS + STOMP) for signaling
• WebRTC PeerConnections for media streams
b. Spring Boot Server
• HTTP layer (AuthController, VideoCallController)
• WebSocket Signaling layer (WebRTCSignalController)
• Interceptor for auth (AuthInterceptor)
• Services (RoomService, UserService)
• Models (Room, User, WebRTCMessage)
c. External Services
• STUN (and TURN) servers for ICE negotiation
d. (Optional) Data Store
• In-memory map or persistent DB (not explicitly shown but can be added for production)
Relationships and interactions
• User opens browser → HTTP GET / → Thymeleaf page
• User registers/logs in → AuthController → (UserService persists user)
• User creates/joins room → VideoCallController → Thymeleaf room.html
• room.html JS → opens SockJS connection → STOMP subscribe to /topic/room/{id}
• room.html JS → sends signaling messages (offer/answer/ICE) via WebSocket to WebRTCSignalController
• WebRTCSignalController → broadcasts messages to other participants’ STOMP subscriptions
• Clients establish direct peer connections using ICE (STUN/TURN)
• Media flows peer-to-peer; signaling flows via server
Architectural patterns & design principles
• MVC for HTTP layer (Controllers → Services → Models)
• Single Exchange message bus for signaling (STOMP topics)
• Separation of concerns:
• Config classes isolate Web MVC and WebSocket setup
• Controllers isolate HTTP vs. signaling logic
• Services encapsulate business logic (room and user management)
Diagramming guidance
• HTTP requests/ responses between Client UI and Auth/VideoCall controllers
• WebSocket messages between Client SockJS and WebRTCSignalController
• ICE negotiation through STUN/TURN servers
• Blue for Client-side (UI, signaling, media)
• Green for Server components (controllers, services, configs)
• Orange for External services (STUN/TURN)
• Rectangles for modules
• Clouds for external services