Hantera AEM-värdar

Det här exemplet, som är löst baserat på AEM Headless React-appen, visar hur AEM GraphQL API-begäranden kan konfigureras för att ansluta till olika AEM-tjänster baserat på miljövariabler.

Reaktionsappar bör använda AEM Headless Client för JavaScript för att interagera med AEM GraphQL API:er. Klienten AEM Headless, som tillhandahålls av AEM Headless Client för JavaScript, måste initieras med den AEM Service Host som den ansluter till.

Reagera på miljöfil

Reaktionen använder anpassade miljöfiler, eller .env filer, som lagras i projektets rot för att definiera build-specifika värden. Filen .env.development innehåller till exempel värden som används under utvecklingen, medan .env.production innehåller värden som används för produktionsbyggen.

• .env.development

# Environment variable used to specify the AEM service the React app will connect to when running under this profile
REACT_APP_AEM_HOST=https://publish-p123-e456.adobeaemcloud.com
...

.env filer för annan användning kan anges genom att .env efterkorrigeras och en semantisk beskrivning, till exempel .env.stage eller .env.production. Olika .env-filer kan användas när du kör eller skapar React-appen genom att ställa in REACT_APP_ENV innan du kör ett npm-kommando.

En React-apps package.json kan till exempel innehålla följande scripts-konfiguration:

• package.json

...
"scripts": {
  "build:development": "REACT_APP_ENV=development npm run build",
  "build:stage": "REACT_APP_ENV=stage npm run build",
  "build:production": "REACT_APP_ENV=production npm run build"
},
...

AEM headless Client

AEM Headless-klienten för JavaScript innehåller en AEM Headless-klient som gör HTTP-begäranden till AEM GraphQL API:er. Klienten AEM Headless måste initieras med den AEM-värd som den interagerar med, med hjälp av värdet från den aktiva .env-filen.

• src/api/headlessClient.js

const { AEMHeadless } = require('@adobe/aem-headless-client-js');
...
// Get the environment variables for configuring the headless client,
// specifically the `REACT_APP_AEM_HOST` which contains the AEM service host.
const {
    REACT_APP_AEM_HOST,         // https://publish-p123-e456.adobeaemcloud.com
    REACT_APP_GRAPHQL_ENDPOINT,
} = process.env;
...

// Initialize the AEM Headless client with the AEM Service host, which dictates the AEM service provides the GraphQL data.
export const aemHeadlessClient = new AEMHeadless({
    serviceURL: REACT_APP_AEM_HOST,
    endpoint: REACT_APP_GRAPHQL_ENDPOINT
});

Reagera useEffect(…)-krok

Anrop av funktionen Custom React useEffect anropar klienten AEM Headless, som initieras med AEM-värden, för att återge vyn för komponenten React.

• src/api/persistedQueries.js

import { aemHeadlessClient , mapErrors} from "./headlessClient";
...
// The exported useEffect hook
export const getAdventureByPath = async function(adventurePath) {
    const queryVariables = {'adventurePath': adventurePath};
    return executePersistedQuery('wknd-shared/adventures-by-path', queryVariables);
}
...
// Private function that invokes the aemHeadlessClient
const executePersistedQuery = async function(persistedQueryPath, queryVariables) {
    let data;
    let errors;

    try {
        // Run the persisted query using using the aemHeadlessClient that's initialized with the AEM host
        const response = await aemHeadlessClient.runPersistedQuery(persistedQueryPath, queryVariables);
        // The GraphQL data is stored on the response's data field
        data = response.data;
        errors = response.errors ? mapErrors(response.errors) : undefined;
    } catch (e) {
        console.error(e.toJSON());
        errors = e;
    }

    return {data, errors};
}

Reaktionskomponent

Den anpassade useEffect-kroken useAdventureByPath importeras och används för att hämta data med AEM Headless-klienten och återge innehållet till slutanvändaren.

• src/components/AdventureDetail.js

import { useAdventureByPath } from './api/persistedQueries';
...
// Query AEM GraphQL APIs via the useEffect hook that invokes the AEM Headless client initialized with the AEM host
let { data, error } = useAdventureByPath('/content/dam/wknd-shared/en/adventures/bali-surf-camp/adobestock-175749320.jpg')

...

Det här exemplet, som baseras på exemplet med AEM Headless iOS™-appen, visar hur AEM GraphQL API-begäranden kan konfigureras för att ansluta till olika AEM-värdar baserat på build-specifika konfigurationsvariabler.

iOS™-appar kräver en anpassad AEM Headless-klient för att kunna interagera med AEM GraphQL API:er. AEM Headless-klienten måste skrivas så att AEM tjänstvärd kan konfigureras.

Bygg konfiguration

XCode-konfigurationsfilen innehåller standardkonfigurationsinformationen.

• Config.xcconfig

// The http/https protocol scheme used to access the AEM_HOST
AEM_SCHEME = https

// Target hostname for AEM service, do not include the scheme: http:// or https://
AEM_HOST = publish-p123-e789.adobeaemcloud.com
...

Initiera den anpassade AEM headless-klienten

I exempelappen AEM Headless iOS används en anpassad AEM Headless-klient som initierats med konfigurationsvärdena för AEM_SCHEME och AEM_HOST.

...
let aemScheme: String = try Configuration.value(for: "AEM_SCHEME")  // https
let aemHost: String = try Configuration.value(for: "AEM_HOST")      // publish-p123-e456.adobeaemcloud.com

let aemHeadlessClient = Aem(scheme: aemScheme, host: aemHost);

Den anpassade huvudlösa AEM-klienten (api/Aem.swift) innehåller metoden makeRequest(..) som prefixerar AEM GraphQL API:er med den konfigurerade AEM scheme och host.

• api/Aem.swift

/// #makeRequest(..)
/// Generic method for constructing and executing AEM GraphQL persisted queries
private func makeRequest(persistedQueryName: String, params: [String: String] = [:]) -> URLRequest {
    // Encode optional parameters as required by AEM
    let persistedQueryParams = params.map { (param) -> String in
        encode(string: ";\(param.key)=\(param.value)")
    }.joined(separator: "")

    // Construct the AEM GraphQL persisted query URL, including optional query params
    let url: String = "\(self.scheme)://\(self.host)/graphql/execute.json/" + persistedQueryName + persistedQueryParams;

    var request = URLRequest(url: URL(string: url)!);

    return request;
}

Det går att skapa nya byggkonfigurationsfiler för att ansluta till olika AEM-tjänster. De build-specifika värdena för AEM_SCHEME och AEM_HOST används baserat på den valda versionen i XCode, vilket gör att den anpassade AEM Headless-klienten kan ansluta till rätt AEM-tjänst.

I det här exemplet, som baseras på exemplet med AEM Headless Android™-appen, visas hur AEM GraphQL API-begäranden kan konfigureras för att ansluta till olika AEM-tjänster baserat på build-specifika (eller arom) konfigurationsvariabler.

Android™-appar (skrivna i Java™) bör använda AEM Headless Client för Java™ för att interagera med AEM GraphQL API:er. Klienten AEM Headless, som tillhandahålls av AEM Headless Client för Java™, måste initieras med den AEM Service Host som den ansluter till.

Bygg konfigurationsfil

Android™-appar definierar"productFlavors" som används för att skapa artefakter för olika användningsområden.
I det här exemplet visas hur två Android™-produktsmak kan definieras, vilket ger olika AEM-tjänstvärdar (AEM_HOST) för utveckling (dev) och produktion (prod).

En ny flavorDimension med namnet env skapas i appens build.gradle-fil.

I dimensionen env definieras två productFlavors: dev och prod. Varje productFlavor använder buildConfigField för att ange byggspecifika variabler som definierar den AEM-tjänst som ska anslutas till.

• app/build.gradle

android {
    ...
    flavorDimensions 'env'
    productFlavors {
        dev {
            dimension 'env'
            applicationIdSuffix '.dev'
            buildConfigField "String", "AEM_HOST", '"http://10.0.2.2:4503"'
            ...
        }
        prod {
            dimension 'env'
            buildConfigField "String", "AEM_HOST", '"https://publish-p123-e789.adobeaemcloud.com"'
            ...
        }
    }
    ...
}

Android™ loader

Initiera AEMHeadlessClient-byggaren som tillhandahålls av AEM Headless Client för Java™ med värdet AEM_HOST från fältet buildConfigField.

• app/src/main/java/com/adobe/wknd/androidapp/loader/AdventuresLoader.java

public class AdventuresLoader extends AsyncTaskLoader<AdventureList> {
    ...

    @Override
    public AdventureList loadInBackground() {
        ...
        // Initialize the AEM Headless client using the AEM Host exposed via BuildConfig.AEM_HOST
        AEMHeadlessClientBuilder builder = AEMHeadlessClient.builder().endpoint(BuildConfig.AEM_HOST);
        AEMHeadlessClient client = builder.build();
        // With the AEM headless client initialized, make GraphQL persisted query calls to AEM
        ...
    }
    ...
}

När du skapar Android™-appen för olika användningsområden anger du varianten env och motsvarande värdvärde för AEM används.

Det här exemplet, som baseras på exempelappen AEM Headless React, visar hur bild-URL:er kan konfigureras för att ansluta till rätt AEM Services baserat på miljövariabler.

I det här exemplet visas hur du prefix i bildreferensfältet _dynamicUrl med en konfigurerbar REACT_APP_AEM_HOST-miljövariabel.

Reagera på miljöfil

Reaktionen använder anpassade miljöfiler, eller .env filer, som lagras i projektets rot för att definiera build-specifika värden. Filen .env.development innehåller till exempel värden som används under utvecklingen, medan .env.production innehåller värden som används för produktionsbyggen.

• .env.development

# Environment variable used to specify the AEM service the React app will connect to when running under this profile
REACT_APP_AEM_HOST=https://publish-p123-e456.adobeaemcloud.com
...

.env filer för annan användning kan anges genom att .env efterkorrigeras och en semantisk beskrivning, till exempel .env.stage eller .env.production. Olika .env-filer kan användas när du kör eller skapar React-appen genom att ställa in REACT_APP_ENV innan du kör ett npm-kommando.

En React-apps package.json kan till exempel innehålla följande scripts-konfiguration:

• package.json

...
"scripts": {
  "build:development": "REACT_APP_ENV=development npm run build",
  "build:stage": "REACT_APP_ENV=stage npm run build",
  "build:production": "REACT_APP_ENV=production npm run build"
},
...

Reaktionskomponent

Komponenten React importerar miljövariabeln REACT_APP_AEM_HOST och prefixerar värdet för bilden _dynamicUrl för att ge en fullt matchningsbar bild-URL.

Samma REACT_APP_AEM_HOST-miljövariabel används för att initiera den AEM Headless-klient som används av useAdventureByPath(..) anpassad useEffect-krok som används för att hämta GraphQL-data från AEM. Om du använder samma variabel för att konstruera GraphQL API-begäran som bild-URL:en måste du se till att React-appen interagerar med samma AEM-tjänst för båda användningsområdena.

• src/components/AdventureDetail.js

...
// Import the AEM origin from the app's environment configuration
const AEM_HOST = env.process.REACT_APP_AEM_HOST; // https://publish-p123-e456.adobeaemcloud.com

let { data, error } = useAdventureByPath('/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp')

return (
    // Prefix the image src URL with the AEM host
    <img src={AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl }>
    {/* Resulting in: <img src="https://publish-p123-e456.adobeaemcloud.com/adobe/dynamicmedia/deliver/dm-aid--de43411-88ec-4c4d-b5ef-e3dc4bc0cb42/adobestock-175749320.jpg"/>  */}
)

Det här exemplet, som baseras på exemplet med AEM Headless iOS™-appen, visar hur AEM image-URL:er kan konfigureras för att ansluta till olika AEM-värdar baserat på build-specifika konfigurationsvariabler.

Bygg konfiguration

XCode-konfigurationsfilen innehåller standardkonfigurationsinformationen.

• Config.xcconfig

// The http/https protocol scheme used to access the AEM_HOST
AEM_SCHEME = https

// Target hostname for AEM service, do not include the scheme: http:// or https://
AEM_HOST = publish-p123-e789.adobeaemcloud.com
...

URL-generator för bild

I Aem.swift, den anpassade AEM headless-klientimplementeringen, tar en anpassad funktion imageUrl(..) bildsökvägen som anges i fältet _dynamicUrl i GraphQL-svaret och lägger till den i AEM-värden. Den här funktionen anropas sedan i iOS-vyerna när en bild återges.

• WKNDAdventures/AEM/Aem.swift

class Aem: ObservableObject {
    let scheme: String
    let host: String
    ...
    init(scheme: String, host: String) {
        self.scheme = scheme
        self.host = host
    }
    ...
    /// Prefixes AEM image dynamicUrl with the AEM scheme/host
    func imageUrl(dynamicUrl: String) -> URL {
        return URL(string: "\(self.scheme)://\(self.host)\(dynamicUrl)")!
    }
    ...
}

iOS view

IOS-vyn och prefixerar bildvärdet _dynamicUrl för att ge en fullt matchningsbar bild-URL.

• WKNDAdventures/Views/AdventureListItemView.swift

import SDWebImageSwiftUI
...
struct AdventureListItemView: View {
    @EnvironmentObject private var aem: Aem

    var adventure: Adventure

    var body: some View {
        HStack {
            // Path the image dynamicUrl to `aem.imageUrl(..)` to prepend the AEM service host
            AdventureRowImage(imageUrl: aem.imageUrl(dynamicUrl: adventure.image()))
            Text(adventure.title)
            Spacer()
        }
    }
}
...

Det går att skapa nya byggkonfigurationsfiler för att ansluta till olika AEM-tjänster. De build-specifika värdena för AEM_SCHEME och AEM_HOST används baserat på den valda versionen i XCode, vilket gör att den anpassade AEM Headless-klienten interagerar med rätt AEM-tjänst.

I det här exemplet, som baseras på exemplet med AEM Headless Android™-appen, visas hur AEM bild-URL:er kan konfigureras för att ansluta till olika AEM-tjänster baserat på build-specifika (eller arom) konfigurationsvariabler.

Bygg konfigurationsfil

Android™-appar definierar"productFlavors" som används för att skapa artefakter för olika användningsområden.
I det här exemplet visas hur två Android™-produktsmak kan definieras, vilket ger olika AEM-tjänstvärdar (AEM_HOST) för utveckling (dev) och produktion (prod).

En ny flavorDimension med namnet env skapas i appens build.gradle-fil.

I dimensionen env definieras två productFlavors: dev och prod. Varje productFlavor använder buildConfigField för att ange byggspecifika variabler som definierar den AEM-tjänst som ska anslutas till.

• app/build.gradle

android {
    ...
    flavorDimensions 'env'
    productFlavors {
        dev {
            dimension 'env'
            applicationIdSuffix '.dev'
            buildConfigField "String", "AEM_HOST", '"http://10.0.2.2:4503"'
            ...
        }
        prod {
            dimension 'env'
            buildConfigField "String", "AEM_HOST", '"https://publish-p123-e789.adobeaemcloud.com"'
            ...
        }
    }
    ...
}

Läsa in AEM-bilden

Android™ använder en ImageGetter för att hämta och lokalt cachelagra bilddata från AEM. I prepareDrawableFor(..) används AEM-tjänstvärden, som definieras i den aktiva build-konfigurationen, som prefix till bildsökvägen för att skapa en matchningsbar URL till AEM.

• app/src/main/java/com/adobe/wknd/androidapp/loader/RemoteImagesCache.java

...
public class RemoteImagesCache implements Html.ImageGetter {
    ...
    private final Map<String, Drawable> drawablesByPath = new HashMap<>();
    ...
    public void prepareDrawableFor(String path) {
        ...

        // Prefix the image path with the build config AEM_HOST variable
        String urlStr = BuildConfig.AEM_HOST + path;

        URL url = new URL(urlStr);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        // Get the image data from AEM
        Drawable drawable = Drawable.createFromStream(is, new File(path).getName());
        ...
        // Save the image data into the cache using the path as the key
        drawablesByPath.put(path, drawable);
        ...
    }

    @Override
    public Drawable getDrawable(String dynamicUrl) {
        // Get the image data from the cache using the dynamicUrl as the key
        return drawablesByPath.get(dynamicUrl);
    }
}

Android™-vy

I vyn Android™ hämtas bilddata via RemoteImagesCache med hjälp av värdet _dynamicUrl från GraphQL-svaret.

• app/src/main/java/com/adobe/wknd/androidapp/AdventureDetailFragment.java

...
public class AdventureDetailFragment extends Fragment implements LoaderManager.LoaderCallbacks<Adventure> {
    ...
    private ImageView adventureDetailImage;
    ...

    private void updateContent() {
        ...
        adventureDetailImage.setImageDrawable(RemoteImagesCache.getInstance().getDrawable(adventure.getPrimaryImageDynamicUrl()));
        ...
    }
...
}

När du skapar Android™-appen för olika användningsområden anger du varianten env och motsvarande värdvärde för AEM används.