{"id":22746159,"url":"https://github.com/meteorgx/actor-spring-boot-starter","last_synced_at":"2025-03-30T05:20:26.200Z","repository":{"id":217371664,"uuid":"743712086","full_name":"MeteorGX/actor-spring-boot-starter","owner":"MeteorGX","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-05T17:56:29.000Z","size":53,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-05T07:26:59.288Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MeteorGX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-15T20:27:01.000Z","updated_at":"2024-06-27T01:32:24.000Z","dependencies_parsed_at":"2024-01-16T02:20:03.737Z","dependency_job_id":"6a058b76-5520-4bf1-b1a0-72a43ea28c9d","html_url":"https://github.com/MeteorGX/actor-spring-boot-starter","commit_stats":null,"previous_names":["meteorgx/actor-spring-boot-starter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorGX%2Factor-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorGX%2Factor-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorGX%2Factor-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorGX%2Factor-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MeteorGX","download_url":"https://codeload.github.com/MeteorGX/actor-spring-boot-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246278442,"owners_count":20751764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-11T02:11:47.267Z","updated_at":"2025-03-30T05:20:26.185Z","avatar_url":"https://github.com/MeteorGX.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getting Started\n\nActor-like multi-threading library based on SpringBoot, developing a relatively simple websocket server.\n\n## Example\n\nImport the following libraries | 引入以下的类库:\n\n\u003e note: websocket is not required, can switch netty to enable tcp | websocket 并不是必须, 可以切换 netty 启用 tcp\n\n```xml\n\n\u003cdependencies\u003e\n    \u003c!-- websocket --\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.springframework.boot\u003c/groupId\u003e\n        \u003cartifactId\u003espring-boot-starter-websocket\u003c/artifactId\u003e\n    \u003c/dependency\u003e\n\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.meteorcat.spring.boot\u003c/groupId\u003e\n        \u003cartifactId\u003eactor-spring-boot-starter\u003c/artifactId\u003e\n        \u003cversion\u003e{actor-starter-version}\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\nFirst, create actor config | 首先, 创建 Actor 配置:\n\n```java\n\n@Configuration\npublic class ActorConfig {\n\n    private final ApplicationContext context;\n\n\n    public ActorConfig(ApplicationContext context) {\n        this.context = context;\n    }\n\n\n    @Bean\n    public ActorEventContainer searchActor() {\n        return new ActorEventContainer(new ActorEventMonitor(5), context);\n    }\n}\n```\n\nAfterwards, generate websocket server | 之后, 生成 websocket 服务:\n\n```java\n/**\n * Global WebSocket Service\n */\n@Order\n@Component\npublic class WebSocketApplication extends TextWebSocketHandler {\n\n    /**\n     * Logger\n     */\n    Logger logger = LoggerFactory.getLogger(WebSocketApplication.class);\n\n\n    /**\n     * JSON Parser\n     */\n    ObjectMapper mapper = new ObjectMapper();\n\n\n    /**\n     * Actor events\n     */\n    final ActorEventContainer container;\n\n    /**\n     * construct method\n     *\n     * @param container Actor events\n     */\n    public WebSocketApplication(ActorEventContainer container) {\n        this.container = container;\n    }\n\n\n    /**\n     * Established\n     *\n     * @param session handler\n     * @throws Exception Error\n     */\n    @Override\n    public void afterConnectionEstablished(@NonNull WebSocketSession session) throws Exception {\n        logger.debug(\"Established = {}\", session);\n    }\n\n\n    /**\n     * Closed\n     *\n     * @param session handler\n     * @param status  close state\n     * @throws Exception Error\n     */\n    @Override\n    public void afterConnectionClosed(@NonNull WebSocketSession session, @NonNull CloseStatus status) throws Exception {\n        logger.debug(\"Close = {},{}\", session, status);\n    }\n\n\n    /**\n     * Text - Callback\n     *\n     * @param session Websocket\n     * @param message data\n     * @throws Exception Error\n     */\n    @Override\n    protected void handleTextMessage(@NonNull WebSocketSession session, @NonNull TextMessage message) throws Exception {\n        logger.debug(\"Message = {},{}| Thread = {}\", session, message.getPayload(), Thread.currentThread().getId());\n\n        // empty?\n        String payload = message.getPayload();\n        if (payload.isBlank()) return;\n\n        // format { op: int, args: object }\n        JsonNode json = mapper.readTree(payload);\n        if (!json.isObject()) {\n            logger.error(\"failed by transfer data\");\n            return;\n        }\n\n        // op or args exist?\n        if (!json.has(\"op\") || !json.has(\"args\")) {\n            logger.error(\"failed by transfer data\");\n            return;\n        }\n\n        // op is int? args is object?\n        JsonNode opNode = json.get(\"op\");\n        JsonNode argsNode = json.get(\"args\");\n        if (!opNode.isInt() || !argsNode.isObject()) {\n            logger.error(\"failed by transfer data\");\n            return;\n        }\n\n        // push message queue\n        Integer op = opNode.asInt();\n        ActorConfigurer configurer = container.get(op);\n        if (configurer != null) {\n            configurer.invoke(op, 0, container, session, argsNode);\n        }\n    }\n}\n```\n\nBy the way, don't forget the websocket configuration | 随便说下, 不要忘记 websocket 配置:\n\n```java\n\n@Configuration\n@EnableWebSocket\npublic class WebSocketConfig implements WebSocketConfigurer {\n\n    /**\n     * path\n     */\n    @Value(\"${websocket.server.path:/}\")\n    private String serverPath;\n\n    /**\n     * buffer\n     */\n    @Value(\"${websocket.buffer.max.size:8192}\")\n    private Integer bufferMaxSize;\n\n\n    /**\n     * timeout\n     */\n    @Value(\"${websocket.idle.timeout:600000}\")\n    private Long idleTimeout;\n\n\n    /**\n     * origins\n     */\n    @Value(\"${websocket.allowed.origins:*}\")\n    private String allowOrigins;\n\n\n    /**\n     * load @Component websocket\n     */\n    private final WebSocketApplication handler;\n\n    /**\n     * get @Component websocket\n     *\n     * @param handler instance\n     */\n    public WebSocketConfig(WebSocketApplication handler) {\n        this.handler = handler;\n    }\n\n\n    /**\n     * register websocket\n     *\n     * @param registry register handler\n     */\n    @Override\n    public void registerWebSocketHandlers(@NonNull WebSocketHandlerRegistry registry) {\n        if (handler == null) {\n            throw new RuntimeException(\"failed by WebSocketHandler: WebSocketHandler\");\n        }\n        registry.addHandler(handler, serverPath).setAllowedOrigins(allowOrigins);\n    }\n\n\n    /**\n     * global Servlet configs\n     *\n     * @return ServletServerContainerFactoryBean\n     */\n    @Bean\n    public ServletServerContainerFactoryBean createWebSocketContainer() {\n        ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();\n        container.setMaxTextMessageBufferSize(bufferMaxSize);\n        container.setMaxBinaryMessageBufferSize(bufferMaxSize);\n        container.setMaxSessionIdleTimeout(idleTimeout);\n        return container;\n    }\n}\n```\n\nOkay, now it's time to write the logic code | 好的, 现在可以编写逻辑代码:\n\n```java\n\n@EnableActor(owner = EchoLogic.class)\npublic class EchoLogic extends ActorConfigurer {\n\n\n    /**\n     * echo server\n     * request: { \"op\": 100, \"args\":{ \"text\": \"hello.world\"}}\n     * response: { \"text\": \"hello.world\"}\n     *\n     * @param session websocket handler\n     * @param node    JSON\n     * @throws IOException ERROR\n     */\n    @ActorMapping(value = 100)\n    public void echo(ActorEventContainer container, WebSocketSession session, JsonNode node) throws IOException {\n        session.sendMessage(new TextMessage(node.toString()));\n    }\n\n    public Map\u003cWebSocketSession, ScheduledFuture\u003c?\u003e\u003e keepAlive = new HashMap\u003c\u003e();\n\n    /**\n     * Init\n     *\n     */\n    @Override\n    public void init() {\n        logger.warn(\"server startup\");\n    }\n\n    /**\n     * Exit\n     */\n    @Override\n    public void destroy() {\n        logger.warn(\"server exit\");\n    }\n\n    /**\n     * keep-alive\n     * request: { \"op\": 111, \"args\":{ }}\n     * response: timestamp\n     *\n     * @param session websocket handler\n     * @throws IOException ERROR\n     */\n    @ActorMapping(value = 111)\n    public void tick(ActorEventContainer container, WebSocketSession session, JsonNode node) throws IOException {\n        if (!keepAlive.containsKey(session)) {\n            ScheduledFuture\u003c?\u003e future = container.scheduleAtFixedRate(() -\u003e {\n                if (!session.isOpen()) {\n                    keepAlive.get(session).cancel(true);\n                    keepAlive.remove(session);\n                }\n\n                try {\n                    long timestamp = System.currentTimeMillis();\n                    session.sendMessage(new TextMessage(Long.toString(timestamp)));\n                } catch (IOException e) {\n                    throw new RuntimeException(e);\n                }\n            }, 5, 5, TimeUnit.SECONDS);\n            keepAlive.put(session, future);\n        }\n    }\n}\n```\n\nRequest json data, test the logical code | 请求 JSON 数据, 测试这些逻辑代码:\n\n```json lines\n// echo mapping\n{\n  \"op\": 100,\n  \"args\": {\n    \"text\": \"hello.world\"\n  }\n}\n\n// keep-alive request\n{\n  \"op\": 111,\n  \"args\": {}\n}\n```\n\n\u003e note: If the Bean thread manager is unable to call scheduled tasks, please use the configuration '\n\u003e spring.main.allow-bean-definition-overriding=true' \n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeteorgx%2Factor-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeteorgx%2Factor-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeteorgx%2Factor-spring-boot-starter/lists"}