วิธีใช้พร็อพเพอร์ตี้ในคําขอราคาเสนอ Java

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X
ข้อมูล

ข้อความเสริมของ Java คืออะไร

หากยังไม่เคยใช้ไฮไลต์ Java เราขอแนะนำให้เริ่มต้นด้วยวิธีสร้างไฮไลต์ Java

การใช้พร็อพเพอร์ตี้ในข้อความไฮไลต์ Java

พร็อพเพอร์ตี้ช่วยให้คุณระบุคู่ชื่อ/ค่าในนโยบายไฮไลต์ของ Java ที่คุณเข้าถึงได้จากโค้ด Java ขณะรันไทม์ คุณต้องระบุค่าสตริงลิเทอรัลสำหรับแต่ละพร็อพเพอร์ตี้ คุณจะอ้างอิงตัวแปรโฟลว์ในองค์ประกอบนี้ไม่ได้

มาดูกันที่ตัวอย่างข้อความเสริม Java ที่ใช้พร็อพเพอร์ตี้ ในตัวอย่างนี้ เราจะสร้างพร็อกซีที่มีนโยบายไฮไลต์ของ Java นโยบายนี้ใช้องค์ประกอบ <Properties> เพื่อระบุคู่ของชื่อ/ค่า ในโค้ด Java เราจะดึงค่าและใช้เพื่อตั้งค่าส่วนหัวการตอบกลับ

ดาวน์โหลดโปรเจ็กต์

คุณดาวน์โหลดโปรเจ็กต์นี้ได้จากที่เก็บ api-platform-samples ของ Apigee ใน GitHub เพื่อความสะดวก

  1. ดาวน์โหลดหรือโคลน api-platform-samples ลงในระบบ
  2. ในเทอร์มินัลหรือตัวแก้ไขโค้ดที่ต้องการ ให้ไปที่โปรเจ็กต์ api-platform-samples/doc-samples/java-properties

นโยบายข้อความไฮไลต์ Java

นโยบายใช้องค์ประกอบ <Properties> องค์ประกอบนี้ช่วยให้คุณระบุคู่ของชื่อ/ค่าได้ ระหว่างรันไทม์ โค้ด Java จะเข้าถึงค่าของพร็อพเพอร์ตี้ที่ระบุไว้ในนโยบายได้ ซึ่งจะพบได้เร็วๆ นี้

<JavaCallout name="java-callout">         
    <ClassName>com.apigeesample.JavaProperties</ClassName>         
    <ResourceURL>java://edge-custom-policy-java-properties.jar</ResourceURL>         
    <Properties>              
        <Property name="prop">WORLD!</Property>             
    </Properties> 
</JavaCallout>

ตัวอย่างโค้ด Java

โค้ด Java สำหรับตัวอย่างนี้แสดงวิธีเรียกข้อมูลพร็อพเพอร์ตี้ที่ระบุไว้ในนโยบายข้อความไฮไลต์ Java ในโปรเจ็กต์ตัวอย่าง คุณจะเห็นซอร์สโค้ดใน java-properties/callout/src/main/java/JavaProperties.java เราจะแนะนำขั้นตอนการคอมไพล์และทำให้โค้ดใช้งานได้ในภายหลังในหัวข้อนี้

package com.apigeesample;

import com.apigee.flow.execution.ExecutionContext;
import com.apigee.flow.execution.ExecutionResult;
import com.apigee.flow.execution.spi.Execution;
import com.apigee.flow.message.MessageContext;

import java.util.Map;

public class JavaProperties implements Execution {

	private Map <String,String> properties; // read-only

	public JavaProperties(Map <String,String> properties) {
	        this.properties = properties;
	}

	public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) {

		try {

		    messageContext.getMessage().setHeader("X-PROPERTY-HELLO", this.properties.get("prop"));

            return ExecutionResult.SUCCESS;

		} catch (Exception e) {
			return ExecutionResult.ABORT;
		}
	}
}

คอมไพล์โค้ดด้วย Maven

โปรเจ็กต์สร้างขึ้นเพื่อให้คุณคอมไพล์ด้วย Maven ได้ หากคุณต้องการใช้ javac เราจะรวมตัวอย่างไว้ด้วย

  1. ตรวจสอบว่าคุณได้ติดตั้ง Maven แล้ว
    mvn -version
    
  2. เรียกใช้สคริปต์ java-properties/buildsetup.sh สคริปต์นี้จะติดตั้งทรัพยากร Dependency ของ JAR ที่จำเป็นในที่เก็บ Maven ในเครื่อง
  3. cd ลงในไดเรกทอรี java-properties/callout
  4. ดำเนินการ Maven:
    mvn clean package
    
  5. หากต้องการ โปรดยืนยันว่าได้คัดลอกไฟล์ JAR edge-custom-policy-java-properties.jar ไปยัง java-properties/apiproxy/resources/java แล้ว ตำแหน่งนี้เป็นตำแหน่งที่จำเป็นสำหรับไฟล์ JAR ที่คุณต้องการปรับใช้กับพร็อกซี

คอมไพล์ด้วย javac (ไม่บังคับ)

หากต้องการใช้ javac เพื่อคอมไพล์โค้ด คุณจะดำเนินการที่คล้ายกับตัวอย่างต่อไปนี้ได้ (จากไดเรกทอรี java-properties) ระบบได้จัดเตรียมไฟล์ JAR ที่จำเป็นให้คุณในไดเรกทอรี java-properties/lib

  1. cd เป็น api-platform-samples/doc-samples/java-properties
  2. ตรวจสอบว่ามี Javac ในเส้นทางของคุณแล้ว

    javac -version
    
  3. เรียกใช้คำสั่ง javac ต่อไปนี้

    javac -d . -classpath ./lib/expressions-1.0.0.jar:./lib/message-flow-1.0.0.jar:. callout/src/main/java/JavaProperties.java
    
  4. สร้างไฟล์ JAR ดังนี้

    jar -cvf edge-custom-policy-java-properties.jar ./com/apigeesample/JavaProperties.class
  5. คัดลอกไฟล์ JAR ไปยังไดเรกทอรี apiproxy/resources/java นี่คือตำแหน่งที่จำเป็นสำหรับไฟล์ JAR ที่คุณต้องการปรับใช้กับพร็อกซี
    cp edge-custom-policy-java-properties.jar apiproxy/resources/java
    

ทำให้พร็อกซีใช้งานได้และเรียกใช้พร็อกซี

สคริปต์สำหรับทำให้ใช้งานได้มีให้ในไดเรกทอรี ./java-properties แต่ก่อนที่จะเรียกใช้ คุณจะต้องตั้งค่าอย่างรวดเร็ว

  1. cd เป็น api-platform-samples/doc-samples/java-properties
  2. หากยังไม่ได้ดำเนินการ ให้เปิดไฟล์ ../../setup/setenv.sh แล้วแก้ไขไฟล์ตามที่ระบุด้วยข้อมูลบัญชี Apigee ได้แก่ ชื่อผู้ใช้ของคุณ (อีเมลที่เชื่อมโยงกับบัญชี) ชื่อองค์กร และโดเมนที่ใช้เรียกการจัดการ API เช่น โดเมนสำหรับ Edge Cloud คือ https://api.enterprise.apigee.com แต่โดเมนอาจแตกต่างออกไปหากคุณใช้ Edge Private Cloud
  3. บันทึกไฟล์ setenv.sh
  4. ดำเนินการสคริปต์ทำให้ใช้งานได้:
    ./deploy.sh
    
  5. หากการทำให้ใช้งานได้สำเร็จ ให้เรียกใช้สคริปต์เรียกใช้:
    ./invoke.sh
    

    สคริปต์เรียกใช้จะเรียกใช้คำสั่ง cURL ที่มีลักษณะเช่นนี้

    curl  http://$org-$env.$api_domain/java-properties
    

    พร็อกซีแสดงผลส่วนหัว: X-PROPERTY-HELLO: WORLD! โปรดทราบว่าในนโยบาย เราเพิ่มคู่ชื่อ/ค่าพร็อพเพอร์ตี้ "prop/WORLD!" ไฮไลต์ของ Java จะดึงค่า "WORLD!" และตั้งเป็นส่วนหัว X-PROPERTY-HELLO:

    messageContext.getMessage().setHeader("X-PROPERTY-HELLO", this.properties.get("prop"));