keycloak~為keycloak-services專案新增第三方模組(首創)

張佔嶺發表於2023-10-30

我們在對keycloak框架中的核心專案keycloak-services進行二次開發過程中，發現了一個問題，當時有這種需求，在keycloak-services中需要使用infinispan快取，我們直接新增infinispan-core引用之後，在啟動keycloak進出錯了，提示我們沒有找到infinispan.Cache，於是我嘗試瞭如下方法，最終解決了問題。

問題解決的思路與嘗試

  1. 【失敗】使用maven-jar-plugin外掛，新增依賴項，為META-INF/MANIFEST.MF新增dependencies節點
      <dependency>
            <groupId>org.infinispan</groupId>
            <artifactId>infinispan-core</artifactId>
            <scope>provided</scope>
        </dependency>
...
...
      <plugin>
         <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-jar-plugin</artifactId>
          <configuration>
              <archive>
                  <manifestEntries>
                      <Dependencies>org.infinispan,org.infinispan.jboss-marshalling</Dependencies>
                  </manifestEntries>
              </archive>
          </configuration>
      </plugin>
  1. 【失敗】使用maven-shade-plugin外掛，在生產keycloak-services包時，直接把org.infinispan打到包裡
  <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-shade-plugin</artifactId>
      <version>3.2.4</version>
      <configuration>
          <artifactSet>
              <includes>
                  <include>org.infinispan:*</include>
              </includes>
          </artifactSet>
          <promoteTransitiveDependencies>true</promoteTransitiveDependencies>&lt;!&ndash; 是否打包間接依賴 &ndash;&gt;

      </configuration>
      <executions>
          <execution>
              <phase>package</phase>
              <goals>
                  <goal>shade</goal>
              </goals>
          </execution>
      </executions>
  </plugin>

上面shade包打完之後，啟動出現了發現”兩個相同名稱的類“，這時我知道，keycloak的jboss容器已經有一個org.infinispan模組了，所以解決問題的關鍵在於，如何使用它提供的infinispan模組

  1. 【問題解決】 直接修改keycloak-services模組裡的module.xml配置檔案，即可實現，它的優先順序更高，這也是為什麼我在“1步“新增manifest未生效的原因所在

實現的具體步驟，在module.xml中，新增對應的模組即可

  1. 從keycloak容器裡將/opt/jboss/keycloak/modules/system/layers/keycloak/org/keycloak/keycloak-core/main/module.xml複製出來，在檔案的dependencies節點下新增依賴，如<module name="org.infinispan"/>

  2. 修改Dockerfile檔案，將這個module.xml檔案也複製到上面的容器目錄，覆蓋原來的檔案

  3. 重新構建映象，啟動容器，問題解決

相關文章