JavaScript politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Ne

Bu politika, API proxy akışı bağlamında çalışan özel JavaScript kodu eklemenize olanak tanır. Özel JavaScript kodunuzda Apigee Edge JavaScript nesne modelinin nesnelerini, yöntemlerini ve özelliklerini kullanabilirsiniz. Nesne modeli, proxy akışı bağlamında değişkenleri almanızı, ayarlamanızı ve kaldırmanızı sağlar. Nesne modeliyle sağlanan temel şifreleme işlevlerini de kullanabilirsiniz.

Hakkında

JavaScript politikasının birçok kullanım alanı vardır. Örneğin, akış değişkenlerini alıp ayarlayabilir, özel mantık yürütebilir, hata işleme, istek veya yanıtlardan veri çıkarabilir, arka uç hedef URL'sini dinamik olarak düzenleyebilir ve daha pek çok işlem yapabilirsiniz. Bu politika, diğer standart Edge politikalarının kapsamına girmeyen özel davranışlar uygulamanıza olanak tanır. Aslında,assignMessage ve ExtractVariable gibi diğer politikaların uyguladığı davranışların birçoğunu gerçekleştirmek için bir JavaScript politikası kullanabilirsiniz.

JavaScript politikası için önermediğimiz bir kullanım alanı günlük kaydıdır. Message Logging politikası; Splunk, Sumo ve Loggly gibi üçüncü taraf günlük kaydı platformlarının günlük kaydı için çok daha uygundur. Ayrıca, yanıt istemciye geri gönderildikten sonra yürütülen PostClientFlow'da Message Logging politikasını yürüterek API proxy'si performansını iyileştirirsiniz.

JavaScript politikası, yürütülecek bir JavaScript kaynak dosyası belirtmenize olanak tanır veya JavaScript kodunu <Source> öğesiyle doğrudan politikanın yapılandırmasına ekleyebilirsiniz. Her iki durumda da politikanın eklendiği adım yürütüldüğünde JavaScript kodu yürütülür. Kaynak dosya seçeneğinde kaynak kodu, her zaman proxy paketi içindeki standart bir konumda depolanır: apiproxy/resources/jsc. Alternatif olarak, kaynak kodunu ortam veya kuruluş düzeyinde bir kaynak dosyasında depolayabilirsiniz. Talimatlar için Kaynak dosyaları başlıklı makaleyi inceleyin. JavaScript'inizi Apigee kullanıcı arayüzü proxy düzenleyicisi aracılığıyla da yükleyebilirsiniz.

JavaScript kaynak dosyalarının her zaman bir .js uzantısı olmalıdır.

Şu anda desteklenen JavaScript sürümü için Desteklenen yazılımlar ve desteklenen sürümler bölümüne bakın.

Video

JavaScript politikasını kullanarak özel politika uzantılarının nasıl oluşturulacağını öğrenmek için kısa bir video izleyin.

Sana Özel

curl -i -H 'Content-Type: application/x-www-form-urlencoded' -X POST -d 'user=Will' http://myorg-test.apigee.net/js-example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="target-rewrite">
    <DisplayName>target-rewrite</DisplayName>
    <Properties/>
    <ResourceURL>jsc://js-example.js</ResourceURL>
</Javascript>

Öğe referansı

Öğe referansı, JavaScript politikasının öğelerini ve özelliklerini açıklar.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" 
        continueOnError="false" enabled="true" timeLimit="200" 
        name="JavaScript-1">
    <DisplayName>JavaScript 1</DisplayName>
    <Properties>
        <Property name="propName">propertyValue</Property>
    </Properties>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>
    <IncludeURL>jsc://a-javascript-library-file</IncludeURL>
    <ResourceURL>jsc://my-javascript-source-file</ResourceURL>
    <Source>insert_js_code_here</Source>

</Javascript>

<Javascript> Özellikleri

<Javascript name="Javascript-1" enabled="true" continueOnError="false" async="false" timeLimit="200">

Aşağıdaki özellikler bu politikaya özeldir.

Aşağıdaki tabloda, tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

<DisplayName> öğesi

Politikayı, yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı bir doğal dil adıyla etiketlemek için name özelliğine ek olarak kullanın.

<DisplayName>Policy Display Name</DisplayName>

<IncludeURL> öğesi

<ResourceURL> veya <Source> öğesiyle belirtilen ana JavaScript dosyasına bağımlılık olarak yüklenecek bir JavaScript kitaplık dosyası belirtir. Komut dosyaları, politikada listelendikleri sırayla değerlendirilir. Kodunuz, JavaScript nesne modelinin nesnelerini, yöntemlerini ve özelliklerini kullanabilir.

Ek <IncludeURL> öğeleriyle birden fazla JavaScript bağımlılık kaynağı ekleyin.

<IncludeURL>jsc://my-javascript-dependency.js</IncludeURL>

Örnek

Örnekler bölümündeki Temel Örnek'e bakın.

<Mülk> öğesi

Çalışma zamanında JavaScript kodundan erişebileceğiniz bir özelliği belirtir.

<Properties>
    <Property name="propName">propertyValue</Property>
</Properties>

Özellikler

Örnek

Sana Özel bölümündeki örneğe bakın.

<ResourceURL> öğesi

API akışında yürütülecek ana JavaScript dosyasını belirtir. Bu dosyayı, Kaynak dosyaları bölümünde açıklandığı gibi API proxy kapsamında (API proxy paketindeki /apiproxy/resources/jsc altında veya API proxy düzenleyicisinin Gezgini bölmesindeki Komut Dosyaları bölümünde) ya da birden çok API proxy'si arasında yeniden kullanım için kuruluş veya ortam kapsamlarında saklayabilirsiniz. Kodunuz, JavaScript nesne modelinin nesnelerini, yöntemlerini ve özelliklerini kullanabilir.

<ResourceURL>jsc://my-javascript.js</ResourceURL>

Örnek

Örnekler bölümündeki Temel Örnek'e bakın.

<Source> öğesi

JavaScript'i doğrudan politikanın XML yapılandırmasına eklemenize olanak tanır. Eklenen JavaScript kodu, politika API akışında yürütüldüğünde yürütülür.

Örnek

<Javascript name='JS-ParseJsonHeaderFullString' timeLimit='200' >
  <Properties>
    <Property name='inboundHeaderName'>specialheader</Property>
    <Property name='outboundVariableName'>json_stringified</Property>
  </Properties>
  <Source>
var varname = 'request.header.' + properties.inboundHeaderName + '.values.string';
var h = context.getVariable(varname);
if (h) {
  h = JSON.parse(h);
  h.augmented = (new Date()).valueOf();
  var v = JSON.stringify(h, null, 2) + '\n';
  // further indent
  var r = new RegExp('^(\S*)','mg');
  v= v.replace(r,'    $1');
  context.setVariable(properties.outboundVariableName, v);
}
  </Source>
</Javascript>

<SSLInfo> öğesi

JavaScript politikası tarafından oluşturulan tüm HTTP istemci örnekleri için TLS'yi yapılandırmak üzere kullanılan özellikleri belirtir.

    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>

Bir HTTP istemcisi için TLS'yi yapılandırma işlemi, bir TargetEndpoint/TargetServer için TLS'yi yapılandırmak üzere kullandığınız süreçle aynıdır. Daha fazla bilgi için Edge'den arka uca TLS'yi yapılandırma bölümüne bakın.

Kullanım notları

JavaScript politikaları gerçek kod içermez. Bunun yerine, JavaScript politikası bir JavaScript "kaynağına" referans verir ve API akışında JavaScript'in yürütüldüğü Adımı tanımlar. Komut dosyanızı Yönetim Kullanıcı Arayüzü proxy düzenleyicisi aracılığıyla yükleyebilir veya yerel olarak geliştirdiğiniz API proxy'lerindeki /resources/jsc dizinine ekleyebilirsiniz.

JavaScript politika kodunda hata ayıklama

print() işlevini kullanarak İzleme Aracı'ndaki işlem çıkış paneline hata ayıklama bilgileri çıktısı alabilirsiniz. Ayrıntılar ve örnekler için JavaScript print() ifadeleriyle hata ayıklama bölümüne göz atın.

Yazdırma ifadelerini Trace'te görüntülemek için:

1. İzleme Aracı'nı açın ve JavaScript politikanızı içeren bir proxy için izleme oturumu başlatın.
2. Proxy'yi çağırın.
3. İzleme Aracı'nda, çıkış panelini açmak için Tüm İşlemlerden çıkış'ı tıklayın.

   

4. Basılı özetleriniz bu panelde görünür.

İzleme aracına hata ayıklama bilgilerinin çıktısını vermek içinprint() işlevini kullanabilirsiniz. Bu işleve doğrudan JavaScript nesne modeli üzerinden erişilebilir. Ayrıntılar için "print() ifadeleriyle JavaScript hatalarını ayıklama" bölümüne göz atın.

Akış Değişkenleri

Bu politika varsayılan olarak değişkenleri doldurmaz ancak bağlam nesnesinde yöntemler çağırarak JavaScript kodunuzda akış değişkenlerini ayarlayabilir (ve alabilirsiniz). Tipik bir kalıp şöyle görünür:

context.setVariable("response.header.X-Apigee-Target", context.getVariable("target.name"))

Bağlam nesnesi, Apigee Edge JavaScript nesne modelinin bir parçasıdır.

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata kodları ve hata mesajları ile döndürülen hata değişkenleri açıklanmaktadır. Hataları ele almak için hata kuralları geliştiriyorsanız bu bilgiye sahip olmanız önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata değişkenleri

Bu değişkenler, bu politika çalışma zamanında bir hata tetiklediğinde ayarlanır. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler bölümüne bakın.

Örnek hata yanıtı

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Hata kuralı örneği

<FaultRule name="JavaScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(javascript.JavaScript-1.failed = true) </Condition>
</FaultRule>

Şema

Her politika türü, bir XML şeması (.xsd) ile tanımlanır. Referans olarak, GitHub'da politika şemaları bulunabilir.

İlgili konular

• JavaScript nesne modeli
• Talimatlar, politika örnekleri ve JavaScript örnekleri için API proxy'lerini JavaScript ile programlama sayfasına bakın.

Apigee Topluluğu makaleleri

Apigee Topluluğu'nda ilgili şu makaleleri bulabilirsiniz:

• JavaScript'te birden çok değerli üstbilgi nasıl kullanılır?