基于zfoo的SpringBoot web项目

pom.xml

<?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.zfoo</groupId>
    <artifactId>naval</artifactId>
    <version>1.0</version>

    <packaging>jar</packaging>

    <properties>
        <!-- 本项目的其它module版本号 -->
        <zfoo.boot.version>3.0</zfoo.boot.version>
        <zfoo.event.version>3.0</zfoo.event.version>
        <zfoo.hotswap.version>3.0</zfoo.hotswap.version>
        <zfoo.monitor.version>3.0</zfoo.monitor.version>
        <zfoo.net.version>3.0</zfoo.net.version>
        <zfoo.scheduler.version>3.0</zfoo.scheduler.version>
        <zfoo.storage.version>3.0</zfoo.storage.version>
        <zfoo.orm.version>3.0</zfoo.orm.version>
        <zfoo.protocol.version>3.0</zfoo.protocol.version>
        <zfoo.util.version>3.0</zfoo.util.version>

        <!-- 核心spring框架 -->
        <spring.version>5.3.4</spring.version>
        <spring.boot.version>2.4.3</spring.boot.version>

        <!-- 工具包 -->
        <commons-codec.version>1.15</commons-codec.version>
        <commons-io.version>2.8.0</commons-io.version>
        <commons-collections.version>4.4</commons-collections.version>
        <commons-lang.version>3.12.0</commons-lang.version>
        <commons-fileupload.version>1.4</commons-fileupload.version>
        <commons-logging.version>1.2</commons-logging.version>
        <commons-log4j.version>2.14.0</commons-log4j.version>
        <httpcomponents.version>4.5.13</httpcomponents.version>
        <httpcore.version>4.4.14</httpcore.version>
        <google.guava.version>30.1-jre</google.guava.version>
        <google.protobuf.version>3.9.1</google.protobuf.version>
        <google.gson.version>2.8.6</google.gson.version>
        <jprotobuf.version>2.4.13</jprotobuf.version>
        <kryo.version>5.0.3</kryo.version>
        <caffeine.version>2.8.8</caffeine.version>
        <jctools.version>3.2.0</jctools.version>
        <hutool.version>5.5.9</hutool.version>
        <oshi.version>5.7.0</oshi.version>
        <snakeyaml.version>1.28</snakeyaml.version>

        <!-- json和xml解析包 -->
        <jackson.version>2.12.1</jackson.version>
        <fastjson.version>1.2.51</fastjson.version>
        <!-- office文档解析包 -->
        <poi.version>4.1.2</poi.version>
        <!-- 字节码增强 -->
        <javassist.version>3.27.0-GA</javassist.version>
        <bytebuddy.version>1.10.22</bytebuddy.version>

        <!-- 网络通讯框架 -->
        <netty.version>4.1.63.Final</netty.version>

        <!-- 分布式zookeeper核心依赖包 -->
        <zookeeper.version>3.6.1</zookeeper.version>
        <curator.version>5.1.0</curator.version>

        <!-- 数据库和缓存 -->
        <mongodb-driver-sync.version>4.2.1</mongodb-driver-sync.version>
        <jedis.version>3.3.0</jedis.version>

        <!-- 消息队列中间件 -->
        <rocketmq.version>4.5.2</rocketmq.version>

        <!-- elastic search 中间件 -->
        <elastic.search.version>7.9.3</elastic.search.version>
        <elastic.search.spring.version>4.1.5</elastic.search.spring.version>
        <lucene.version>8.6.2</lucene.version>

        <slf4j.version>1.7.30</slf4j.version>
        <logback.version>1.2.3</logback.version>

        <junit.version>4.12</junit.version>

        <!-- java版本和文件编码 -->
        <java.version>11</java.version>
        <file.encoding>UTF-8</file.encoding>
        <jakarta.version>1.3.5</jakarta.version>

        <!-- maven核心插件 -->
        <maven-clean-plugin.version>3.1.0</maven-clean-plugin.version>
        <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
        <maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
        <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
        <maven-jar-plugin.version>3.2.0</maven-jar-plugin.version>
        <maven-shade-plugin.version>3.2.4</maven-shade-plugin.version>
        <versions-maven-plugin.version>2.8.1</versions-maven-plugin.version>

        <!-- 其它 -->
        <lombok.version>1.18.22</lombok.version>

        <project.build.sourceEncoding>${file.encoding}</project.build.sourceEncoding>
        <maven.compiler.encoding>${file.encoding}</maven.compiler.encoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring.boot.version}</version>
            <exclusions>
                <exclusion>
                    <artifactId>mongodb-driver-sync</artifactId>
                    <groupId>org.mongodb</groupId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-to-slf4j</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>jul-to-slf4j</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.yaml</groupId>
                    <artifactId>snakeyaml</artifactId>
                </exclusion>
                <exclusion>
                    <artifactId>jackson-annotations</artifactId>
                    <groupId>com.fasterxml.jackson.core</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>jackson-core</artifactId>
                    <groupId>com.fasterxml.jackson.core</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>jackson-databind</artifactId>
                    <groupId>com.fasterxml.jackson.core</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>${spring.boot.version}</version>
        </dependency>

        <dependency>
            <groupId>com.zfoo</groupId>
            <artifactId>boot</artifactId>
            <version>${zfoo.boot.version}</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
        </dependency>

    </dependencies>

    <build>
        <sourceDirectory>src/main/java</sourceDirectory>
        <testSourceDirectory>src/test/java</testSourceDirectory>

        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring.boot.version}</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <mainClass>com.zfoo.naval.Application</mainClass>
                    <layout>ZIP</layout>
                </configuration>
            </plugin>

            <!-- 清理插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-clean-plugin</artifactId>
                <version>${maven-clean-plugin.version}</version>
            </plugin>

            <!-- 编译插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>${maven-compiler-plugin.version}</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                    <encoding>${file.encoding}</encoding>
                </configuration>
            </plugin>


            <!-- resource资源管理插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>${maven-resources-plugin.version}</version>
                <executions>
                    <execution>
                        <id>copy-resources</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals>
                        <configuration>
                            <encoding>${file.encoding}</encoding>
                            <outputDirectory>${project.build.directory}/resource</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>src/main/resources/</directory>
                                    <filtering>false</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>


            <!-- 测试插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>${maven-surefire-plugin.version}</version>
                <configuration>
                    <forkMode>once</forkMode>
                    <threadCount>10</threadCount>
                    <argLine>-Dfile.encoding=${file.encoding}</argLine>
                </configuration>
            </plugin>

        </plugins>
    </build>

</project>

application.yml

orm:
  id: mongodbConfig
  entity-package: com.zfoo.naval.**.entity
  host:
    database: naval
    user:
    password:
    address:
      - 127.0.0.1:27017
  caches:
    - strategy: hundred
      size: 100
      expire-millisecond: 600000
    - strategy: tenThousand
      size: 10000
      expire-millisecond: 600000
  persisters:
    - strategy: cron30s
      type: cron
      config: 0/30 * * * * ?
    - strategy: time30s
      type: time
      config: 30000

net:
  id: netConfig
  protocol-location: protocol.xml
  csharp-protocol: false
  javascript-protocol: false
  fold-protocol: true

protocol.xml

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>

<!-- native为内部消息，common是公共消息每个模块都能使用 -->
<protocols author="jaysunxiao">

    <module id="1" name="native" minId="0" maxId="100">
        <protocol id="0" location="com.zfoo.net.router.attachment.SignalAttachment"/>
        <protocol id="1" location="com.zfoo.net.router.attachment.GatewayAttachment"/>
        <protocol id="2" location="com.zfoo.net.router.attachment.UdpAttachment"/>
        <protocol id="3" location="com.zfoo.net.router.attachment.HttpAttachment"/>
        <protocol id="4" location="com.zfoo.net.router.attachment.NoAnswerAttachment"/>


        <protocol id="20" location="com.zfoo.net.core.gateway.model.AuthUidToGatewayCheck"/>
        <protocol id="21" location="com.zfoo.net.core.gateway.model.AuthUidToGatewayConfirm"/>
        <protocol id="22" location="com.zfoo.net.core.gateway.model.AuthUidAsk"/>
        <protocol id="23" location="com.zfoo.net.core.gateway.model.GatewaySessionInactiveAsk"/>
        <protocol id="24" location="com.zfoo.net.core.gateway.model.GatewaySynchronizeSidAsk"/>
    </module>



</protocols>

AutoConfiguration.java

package com.zfoo.naval.config;

import com.zfoo.net.config.model.NetConfig;
import com.zfoo.orm.model.config.OrmConfig;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AutoConfiguration {
    @Bean
    @ConfigurationProperties(prefix = "orm")
    public OrmConfig ormConfig() {
        return new OrmConfig();
    }

    @Bean
    @ConfigurationProperties(prefix = "net")
    public NetConfig netConfig() {
        return new NetConfig();
    }
}

Application.java

package com.zfoo.naval;

import com.zfoo.event.model.event.AppStartEvent;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration;
import org.springframework.boot.autoconfigure.data.mongo.MongoReactiveDataAutoConfiguration;
import org.springframework.boot.autoconfigure.data.mongo.MongoReactiveRepositoriesAutoConfiguration;
import org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration;
import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
import org.springframework.boot.autoconfigure.mongo.MongoReactiveAutoConfiguration;
import org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration;
import org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration;

@SpringBootApplication(exclude = {
        // 排除MongoDB自动配置
        MongoDataAutoConfiguration.class,
        MongoRepositoriesAutoConfiguration.class,
        MongoAutoConfiguration.class,
        MongoReactiveAutoConfiguration.class,
        MongoReactiveDataAutoConfiguration.class,
        MongoReactiveRepositoriesAutoConfiguration.class,

        TaskExecutionAutoConfiguration.class,
        TaskSchedulingAutoConfiguration.class
})
public class Application {
    public static void main(String[] args) {
        var context = SpringApplication.run(Application.class, args);

        context.registerShutdownHook();
        context.publishEvent(new AppStartEvent(context));
    }
}

AccountEntity.java

package com.zfoo.naval.entity;

import com.zfoo.orm.model.anno.EntityCache;
import com.zfoo.orm.model.anno.Id;
import com.zfoo.orm.model.anno.Persister;
import com.zfoo.orm.model.entity.IEntity;
import lombok.Data;

@Data
@EntityCache(cacheStrategy = "tenThousand", persister = @Persister("time30s"))
public class AccountEntity implements IEntity<String> {
    /**
     * 账号
     */
    @Id
    private String id;

    /**
     * 密码
     */
    private String name;

    /**
     * 密码
     */
    private String password;

    public static AccountEntity valueOf(String id, String name, String password) {
        var entity = new AccountEntity();
        entity.id = id;
        entity.name = name;
        entity.password = password;
        return entity;
    }

    @Override
    public String id() {
        return id;
    }
}

LoginController.java // 对于orm的插入和删除，必须调用invalidate让缓存失效一下，这样子update才能更新进去。 有初始值的原因是因为：避免缓存穿透，查一次后就以后查询cache。

package com.zfoo.naval.controller;

import com.zfoo.naval.entity.AccountEntity;
import com.zfoo.naval.utils.TaskUtils;
import com.zfoo.orm.OrmContext;
import com.zfoo.orm.model.anno.EntityCachesInjection;
import com.zfoo.orm.model.cache.IEntityCaches;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.UUID;

@RestController
public class LoginController {
    @EntityCachesInjection
    private IEntityCaches<String, AccountEntity> accountEntityCaches;

    /**
     * http://localhost:8080/login?account=1
     *
     * @param account
     * @return
     */
    @GetMapping("/login")
    @ResponseBody
    public Object login(@RequestParam("account") String account) {
        return TaskUtils.runTask(account, () -> {
            AccountEntity entity = accountEntityCaches.load(account);
            if (entity.checkNull()) {
                entity = AccountEntity.valueOf(account, UUID.randomUUID().toString().substring(0, 5), UUID.randomUUID().toString().substring(0, 5));
                OrmContext.getAccessor().insert(entity);
                // 出现增加和删除，必须清空一下缓存
                accountEntityCaches.invalidate(account);
            } else {
                entity.setName(UUID.randomUUID().toString().substring(0, 5));
                entity.setPassword(UUID.randomUUID().toString().substring(0, 5));
            }
            accountEntityCaches.update(entity);
            return entity;
        });
    }
}

TaskUtils.java

package com.zfoo.naval.entity;

import com.zfoo.net.task.TaskBus;

import java.util.concurrent.Callable;
import java.util.concurrent.Future;
import java.util.concurrent.ThreadLocalRandom;

public class TaskUtils {
    public static <T> T runTask(Object hashObj, Callable<T> callable) {
        try {
            Future<T> future = TaskBus.executor(hashObj == null ? ThreadLocalRandom.current().nextInt() : hashObj.hashCode())
                    .submit(callable::call);
            return future.get();
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }
}