Nop

Spring集成

只需引入nop-spring-core-starter模块即可实现Spring框架和Nop平台的集成

<pom>
<dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>io.github.entropy-cloud</groupId>
            <artifactId>nop-bom</artifactId>
            <version>${nop-entropy.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>

    </dependencies>
</dependencyManagement>

<dependencies>
<dependency>
    <groupId>io.github.entropy-cloud</groupId>
    <artifactId>nop-spring-core-starter</artifactId>
</dependency>
</dependencies>
</pom>
  1. Spring框架启动完毕的时候自动调用CoreInitialization.initialize()函数来执行Nop平台的初始化.
    参见NopSpringCoreWebConfig.java
  2. Nop平台管理的bean可以通过@Inject来使用Spring容器中的bean
  3. Spring容器中无法直接使用Nop平台管理的bean，需要使用 BeanContainer.getBeanByType(IDaoProvider.class)等方法来获取
  4. Nop平台和Spring共用application.yaml配置文件，Nop平台的配置格式参见 config.md

仅使用NopOrm来访问数据库

如果仅需要使用NopOrm平台提供的ORM引擎，可以在nop-spring-core-starter的基础上再引入nop-orm模块


<dependencies>
    <dependency>
        <groupId>io.github.entropy-cloud</groupId>
        <artifactId>nop-orm</artifactId>
    </dependency>

    <dependency>
        <groupId>io.github.entropy-cloud</groupId>
        <artifactId>nop-sys-dao</artifactId>
    </dependency>
</dependencies>

如果需要使用NopSysSequence表来统一管理sequence，或者需要扩展字段支持，则可以引入nop-sys-dao模块。

如果希望和Spring共用DataSource，而不是在Nop平台中使用自己管理的nopDataSource，则可以配置

nop.dao.use-parent-data-source=true

这个配置会禁用Nop平台内部的nopDataSource定义，然后将nopDataSource对应于别名dataSource。因此要求Spring容器中提供一个名称为dataSource的数据源定义。

使用Spring事务管理统一管理事务

需要注意的时，如果使用Spring事务，则NopORM的异步执行逻辑会不正确，只能采用同步执行。

nop.dao.use-parent-transaction-factory=true

使用NopGraphQL服务

如果需要使用NopGraphQL服务，则可以引入nop-spring-web-starter模块


<dependencies>
    <dependency>
        <groupId>io.github.entropy-cloud</groupId>
        <artifactId>nop-spring-web-starter</artifactId>
    </dependency>
</dependencies>

如果需要引入orm支持，则引入nop-spring-web-orm-starter，它会自动引入nop-orm，从而引入数据源配置，必须在application.yaml中配置nop.datasource.jdbc-url等参数，或者配置nop.orm.use-parent-data-source=true

集成Nop平台的AMIS前端

仿照nop-for-ruoyi项目的相关配置.
B站视频: 在若依(Ruoyi)框架中集成Nop平台

为Spring和MyBatis增加Delta定制能力

引入 nop-spring-delta模块，然后模块目录下的beans/spring-*.beans.xml文件以及mapper/*.mapper.xml文件支持Delta定制。

nop-spring-delta对于Java中的Mapper接口也增加了定制能力


<bean id="sysUserMapper" parent="nopBaseMapper">
    <property name="mapperInterface" value="io.nop.demo.spring.SysUserMapper"/>
    <property name="mapperTypeEx" value="io.nop.demo.spring.SysUserMapperEx"/>
</bean>

mapperInterface对应于Mapper XML文件中的namespace配置，一般情况下mapperTypeEx与namespace相同，但是在扩展模块中我们可以配置mapperTypeEx使用扩展接口。

具体设计原理参加 spring-delta.md

使用nop-all-for-spring来简化包管理

Nop平台采用多模块设计，目前尚未上传maven中心仓库。如果要把nop平台的包上传私服进行管理，可以仿照nop-all-for-spring模块的做法，先将用到的
Nop平台的包打包为一个nop-all-for-xxx.jar，然后只需要上传这一个jar包即可。

nop-spring-demo2工程演示了使用nop-all-for-spring的具体方法。

因为Nop平台内核已经升级到Quarkus3.0，为了在Spring2.X版本中使用，需要明确指定jakarta相关包的版本号，否则会出现兼容性问题。

打包时重命名包

nop-maven-shaded-plugin插件提供了重命名包的功能。可以通过如下配置实现打包时自动重命名为java包名，并自动修改所有dsl文件中的对应名称。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.5.0</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                    <transformer implementation="io.nop.maven.plugin.shaded.XdslResourceTransformer" />
                    <transformer implementation="io.nop.maven.plugin.shaded.SpringFactoryResourceTransformer" />
                </transformers>
                <artifactSet>
                    <includes>
                        <include>io.github.entropy-cloud:*</include>
                    </includes>
                </artifactSet>
                <filters>
                    <filter>
                        <artifact>*:*</artifact>
                        <excludes>
                            <exclude>META-INF/maven/**</exclude>
                            <exclude>META-INF/native-image/**</exclude>
                        </excludes>
                    </filter>
                </filters>

                <relocations>
                    <relocation>
                        <pattern>io.nop</pattern>
                        <shadedPattern>com.xxx</shadedPattern>
                    </relocation>
                </relocations>
            </configuration>
        </execution>
    </executions>

    <dependencies>
        <dependency>
            <groupId>io.github.entropy-cloud</groupId>
            <artifactId>nop-maven-shaded-plugin</artifactId>
            <version>${nop-entropy.version}</version>
        </dependency>
    </dependencies>
</plugin>