最近在探索 Mendix 時(shí)，我注意到他們有一個(gè) Platform SDK，允許您通過 API 與 mendix 應(yīng)用程序模型進(jìn)行交互。

這給了我一個(gè)想法，探索它是否可以用于創(chuàng)建我們的領(lǐng)域模型。具體來說，是基于現(xiàn)有的傳統(tǒng)應(yīng)用程序創(chuàng)建領(lǐng)域模型。

如果進(jìn)一步推廣，這可用于將任何現(xiàn)有應(yīng)用程序轉(zhuǎn)換為 Mendix 并從那里繼續(xù)開發(fā)。

將 Java/Spring Web 應(yīng)用程序轉(zhuǎn)換為 Mendix

因此，我創(chuàng)建了一個(gè)帶有簡單 API 和數(shù)據(jù)庫層的小型 Java/Spring Web 應(yīng)用程序。為了簡單起見，它使用嵌入式 H2 數(shù)據(jù)庫。

在這篇文章中，我們將僅轉(zhuǎn)換 JPA 實(shí)體。讓我們來看看它們：

@Entity
@Table(name = "CAT")
class Cat {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    private String name;
    private int age;
    private String color;

    @OneToOne
    private Human humanPuppet;

    ... constructor ...
    ... getters ...
}

@Entity
@Table(name = "HUMAN")
public class Human {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    private String name;

    ... constructor ...
    ... getters ...
}

如您所見，它們非常簡單：一只有名字、年齡、顏色的貓和它的人類傀儡，因?yàn)檎缥覀兯?，貓統(tǒng)治著世界。

它們都有一個(gè)自動(dòng)生成的 ID 字段。貓與人類有一對一的聯(lián)系，這樣它就可以隨時(shí)稱呼它的人類。 （如果它不是 JPA 實(shí)體，我會(huì)放置一個(gè) meow() 方法，但讓我們將其留到將來）。

應(yīng)用程序功能齊全，但現(xiàn)在我們只對數(shù)據(jù)層感興趣。

提取 json 中的實(shí)體元數(shù)據(jù)

這可以通過幾種不同的方式來完成：

1. 通過靜態(tài)分析包中的實(shí)體。
2. 通過使用反射在運(yùn)行時(shí)讀取這些實(shí)體。

我選擇了選項(xiàng) 2，因?yàn)樗?，而且我無法輕松找到可以執(zhí)行選項(xiàng) 1 的庫。

接下來，我們需要決定構(gòu)建后如何公開 json。為了簡單起見，我們只需將其寫入文件即可。一些替代方法可能是：

• 通過 api 公開它。這更加復(fù)雜，因?yàn)槟€需要確保端點(diǎn)受到很好的保護(hù)，因?yàn)槲覀儾荒芄_暴露我們的元數(shù)據(jù)。
• 通過一些管理工具公開它，例如 Spring Boot Actuator 或 jmx。它更安全，但仍然需要時(shí)間來設(shè)置。

現(xiàn)在讓我們看看實(shí)際的代碼：

public class MendixExporter {
    public static void exportEntitiesTo(String filePath) throws IOException {
        AnnotatedTypeScanner typeScanner = new AnnotatedTypeScanner(false, Entity.class);

        Set<Class<?>> entityClasses = typeScanner.findTypes(JavaToMendixApplication.class.getPackageName());
        log.info("Entity classes are: {}", entityClasses);

        List<MendixEntity> mendixEntities = new ArrayList<>();

        for (Class<?> entityClass : entityClasses) {
            List<MendixAttribute> attributes = new ArrayList<>();
            for (Field field : entityClass.getDeclaredFields()) {

                AttributeType attributeType = determineAttributeType(field);
                AssociationType associationType = determineAssociationType(field, attributeType);
                String associationEntityType = determineAssociationEntityType(field, attributeType);

                attributes.add(
                        new MendixAttribute(field.getName(), attributeType, associationType, associationEntityType));
            }
            MendixEntity newEntity = new MendixEntity(entityClass.getSimpleName(), attributes);
            mendixEntities.add(newEntity);
        }

        writeToJsonFile(filePath, mendixEntities);
    }
    ...
}

我們首先查找應(yīng)用程序中標(biāo)有 JPA 的 @Entity 注釋的所有類。
然后，對于每堂課，我們：

1. 使用entityClass.getDeclaredFields()獲取聲明的字段。
2. 循環(huán)該類的每個(gè)字段。

對于每個(gè)字段，我們：

1. 確定屬性的類型：
   

   private static final Map<Class<?>, AttributeType> JAVA_TO_MENDIX_TYPE = Map.ofEntries(
           Map.entry(String.class, AttributeType.STRING),
           Map.entry(Integer.class, AttributeType.INTEGER),
           ...
           );
   // we return AttributeType.ENTITY if we cannot map to anything else
   

   本質(zhì)上，我們只是通過在 JAVA_TO_MENDIX_TYPE 映射中查找 java 類型與我們的自定義枚舉值進(jìn)行匹配。

2. 接下來，我們檢查這個(gè)屬性是否實(shí)際上是一個(gè)關(guān)聯(lián)（指向另一個(gè)@Entity）。如果是這樣，我們確定關(guān)聯(lián)的類型：一對一、一對多、多對多：
   

   @Entity
   @Table(name = "CAT")
   class Cat {
       @Id
       @GeneratedValue(strategy = GenerationType.AUTO)
       private Long id;
   
       private String name;
       private int age;
       private String color;
   
       @OneToOne
       private Human humanPuppet;
   
       ... constructor ...
       ... getters ...
   }
   
   @Entity
   @Table(name = "HUMAN")
   public class Human {
       @Id
       @GeneratedValue(strategy = GenerationType.AUTO)
       private Long id;
   
       private String name;
   
       ... constructor ...
       ... getters ...
   }
   

   為此，我們只需檢查之前映射的屬性類型。如果它是 Entity，這僅意味著在之前的步驟中我們無法將其映射到任何原始 java 類型、String 或 Enum。
   然后我們還需要決定它是什么類型的關(guān)聯(lián)。檢查很簡單：如果是 List 類型，則它是一對多，否則是一對一（尚未實(shí)現(xiàn)“多對多”）。

3. 然后我們?yōu)檎业降拿總€(gè)字段創(chuàng)建一個(gè) MendixAttribute 對象。

完成后，我們只需為實(shí)體創(chuàng)建一個(gè) MendixEntity 對象并分配屬性列表。
MendixEntity 和 MendixAttribute 是我們稍后將用來映射到 json 的類：

public class MendixExporter {
    public static void exportEntitiesTo(String filePath) throws IOException {
        AnnotatedTypeScanner typeScanner = new AnnotatedTypeScanner(false, Entity.class);

        Set<Class<?>> entityClasses = typeScanner.findTypes(JavaToMendixApplication.class.getPackageName());
        log.info("Entity classes are: {}", entityClasses);

        List<MendixEntity> mendixEntities = new ArrayList<>();

        for (Class<?> entityClass : entityClasses) {
            List<MendixAttribute> attributes = new ArrayList<>();
            for (Field field : entityClass.getDeclaredFields()) {

                AttributeType attributeType = determineAttributeType(field);
                AssociationType associationType = determineAssociationType(field, attributeType);
                String associationEntityType = determineAssociationEntityType(field, attributeType);

                attributes.add(
                        new MendixAttribute(field.getName(), attributeType, associationType, associationEntityType));
            }
            MendixEntity newEntity = new MendixEntity(entityClass.getSimpleName(), attributes);
            mendixEntities.add(newEntity);
        }

        writeToJsonFile(filePath, mendixEntities);
    }
    ...
}

最后，我們保存一個(gè)List；使用 Jackson 轉(zhuǎn)換為 json 文件。

將實(shí)體導(dǎo)入 Mendix

有趣的部分來了，我們?nèi)绾巫x取上面生成的 json 文件并從中創(chuàng)建 mendix 實(shí)體？

Mendix 的 Platform SDK 有一個(gè) Typescript API 可以與之交互。
首先，我們將創(chuàng)建對象來表示我們的實(shí)體和屬性，以及關(guān)聯(lián)和屬性類型的枚舉：

private static final Map<Class<?>, AttributeType> JAVA_TO_MENDIX_TYPE = Map.ofEntries(
        Map.entry(String.class, AttributeType.STRING),
        Map.entry(Integer.class, AttributeType.INTEGER),
        ...
        );
// we return AttributeType.ENTITY if we cannot map to anything else

接下來，我們需要使用 appId 獲取我們的應(yīng)用程序，創(chuàng)建臨時(shí)工作副本，打開模型，并找到我們感興趣的域模型：

private static AssociationType determineAssociationType(Field field, AttributeType attributeType) {
    if (!attributeType.equals(AttributeType.ENTITY))
        return null;
    if (field.getType().equals(List.class)) {
        return AssociationType.ONE_TO_MANY;
    } else {
        return AssociationType.ONE_TO_ONE;
    }
}

SDK 實(shí)際上會(huì)從 git 中提取我們的 mendix 應(yīng)用程序并進(jìn)行處理。

讀取 json 文件后，我們將循環(huán)實(shí)體：

public record MendixEntity(
        String name,
        List<MendixAttribute> attributes) {
}

public record MendixAttribute(
        String name,
        AttributeType type,
        AssociationType associationType,
        String entityType) {

    public enum AttributeType {
        STRING,
        INTEGER,
        DECIMAL,
        AUTO_NUMBER,
        BOOLEAN,
        ENUM,
        ENTITY;
    }

    public enum AssociationType {
        ONE_TO_ONE,
        ONE_TO_MANY
    }
}

這里我們使用domainmodels.Entity.createIn(domainModel);在我們的域模型中創(chuàng)建一個(gè)新實(shí)體并為其分配一個(gè)名稱。我們可以分配更多屬性，例如文檔、索引，甚至實(shí)體在域模型中呈現(xiàn)的位置。

我們在單獨(dú)的函數(shù)中處理屬性：

interface ImportedEntity {
    name: string;
    generalization: string;
    attributes: ImportedAttribute[];
}

interface ImportedAttribute {
    name: string;
    type: ImportedAttributeType;
    entityType: string;
    associationType: ImportedAssociationType;
}

enum ImportedAssociationType {
    ONE_TO_ONE = "ONE_TO_ONE",
    ONE_TO_MANY = "ONE_TO_MANY"
}

enum ImportedAttributeType {
    INTEGER = "INTEGER",
    STRING = "STRING",
    DECIMAL = "DECIMAL",
    AUTO_NUMBER = "AUTO_NUMBER",
    BOOLEAN = "BOOLEAN",
    ENUM = "ENUM",
    ENTITY = "ENTITY"
}

這里我們唯一需要付出一些努力的就是將屬性類型映射到有效的 mendix 類型。

接下來我們處理關(guān)聯(lián)。首先，由于在我們的Java實(shí)體中關(guān)聯(lián)是通過字段聲明的，因此我們需要區(qū)分哪些字段是簡單屬性，哪些字段是關(guān)聯(lián)。為此，我們只需要檢查它是實(shí)體類型還是原始類型：

const client = new MendixPlatformClient();
const app = await client.getApp(appId);
const workingCopy = await app.createTemporaryWorkingCopy("main");
const model = await workingCopy.openModel();
const domainModelInterface = model.allDomainModels().filter(dm => dm.containerAsModule.name === MyFirstModule")[0];
const domainModel = await domainModelInterface.load();

讓我們創(chuàng)建關(guān)聯(lián)：

function createMendixEntities(domainModel: domainmodels.DomainModel, entitiesInJson: any) {
    const importedEntities: ImportedEntity[] = JSON.parse(entitiesInJson);

    importedEntities.forEach((importedEntity, i) => {
        const mendixEntity = domainmodels.Entity.createIn(domainModel);
        mendixEntity.name = importedEntity.name;

        processAttributes(importedEntity, mendixEntity);
    });

    importedEntities.forEach(importedEntity => {
        const mendixParentEntity = domainModel.entities.find(e => e.name === importedEntity.name) as domainmodels.Entity;
        processAssociations(importedEntity, domainModel, mendixParentEntity);
    });
}

除了名稱之外，我們還有 4 個(gè)重要的屬性需要設(shè)置：

1. 父實(shí)體。這是當(dāng)前實(shí)體。

2. 子實(shí)體。在最后一步中，我們?yōu)槊總€(gè) java 實(shí)體創(chuàng)建了 mendix 實(shí)體?，F(xiàn)在我們只需要根據(jù)實(shí)體中java字段的類型找到匹配的實(shí)體：
   

   function processAttributes(importedEntity: ImportedEntity, mendixEntity: domainmodels.Entity) {
       importedEntity.attributes.filter(a => a.type !== ImportedAttributeType.ENTITY).forEach(a => {
           const mendixAttribute = domainmodels.Attribute.createIn(mendixEntity);
           mendixAttribute.name = capitalize(getAttributeName(a.name, importedEntity));
           mendixAttribute.type = assignAttributeType(a.type, mendixAttribute);
       });
   }
   

3. 關(guān)聯(lián)類型。如果是一對一的，它會(huì)映射到一個(gè)引用。如果是一對多，則映射到參考集。我們現(xiàn)在將跳過多對多。

4. 協(xié)會(huì)所有者。一對一和多對多關(guān)聯(lián)都具有相同的所有者類型：兩者。對于一對一，所有者類型必須為默認(rèn)。

Mendix Platform SDK 將在我們的 mendix 應(yīng)用程序的本地工作副本中創(chuàng)建實(shí)體?，F(xiàn)在我們只需要告訴它提交更改：

@Entity
@Table(name = "CAT")
class Cat {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    private String name;
    private int age;
    private String color;

    @OneToOne
    private Human humanPuppet;

    ... constructor ...
    ... getters ...
}

@Entity
@Table(name = "HUMAN")
public class Human {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    private String name;

    ... constructor ...
    ... getters ...
}

幾秒鐘后，您可以在 Mendix Studio Pro 中打開應(yīng)用程序并驗(yàn)證結(jié)果：

現(xiàn)在你已經(jīng)看到了：貓和人的實(shí)體，它們之間存在一對一的關(guān)聯(lián)。

如果您想親自嘗試或查看完整代碼，請?jiān)L問此存儲(chǔ)庫。

對未來的想法

1. 在這個(gè)示例中，我使用了 Java/Spring 應(yīng)用程序進(jìn)行轉(zhuǎn)換，因?yàn)槲易罹ㄋ?，但任何?yīng)用程序都可以使用。 只需能夠讀取類型數(shù)據(jù)（靜態(tài)或運(yùn)行時(shí)）來提取類和字段名稱就足夠了。
2. 我很好奇嘗試讀取一些 Java 邏輯并將其導(dǎo)出到 Mendix 微流程。我們可能無法真正轉(zhuǎn)換業(yè)務(wù)邏輯本身，但我們應(yīng)該能夠獲得它的結(jié)構(gòu)（至少是業(yè)務(wù)方法簽名？）。
3. 本文中的代碼可以推廣并制作成一個(gè)庫：json 格式可以保持不變，并且可以有一個(gè)庫用于導(dǎo)出 java 類型，另一個(gè)庫用于導(dǎo)入 mendix 實(shí)體。
4. 我們可以使用相同的方法進(jìn)行相反的操作：將 mendix 轉(zhuǎn)換為另一種語言。

結(jié)論

Mendix Platform SDK 是一項(xiàng)強(qiáng)大的功能，允許以編程方式與 mendix 應(yīng)用程序進(jìn)行交互。他們列出了一些示例用例，例如導(dǎo)入/導(dǎo)出代碼、分析應(yīng)用程序復(fù)雜性。
如果您有興趣，請看一下。
對于本文，您可以在此處找到完整代碼。

以上是將 JPA 實(shí)體轉(zhuǎn)換為 Mendix的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！