12장. 함수 개발 참조 가이드
12.1. Quarkus 함수 개발 링크 복사링크가 클립보드에 복사되었습니다!
Quarkus 함수 프로젝트를 생성한 후에는 제공된 템플릿 파일을 수정하여 비즈니스 로직을 기능에 추가할 수 있습니다. 여기에는 함수 호출 구성 및 반환된 헤더 및 상태 코드가 포함됩니다.
12.1.1. 사전 요구 사항 링크 복사링크가 클립보드에 복사되었습니다!
- 함수를 개발하려면 먼저 OpenShift Serverless Functions 구성에서 설정 단계를 완료해야 합니다.
12.1.2. Quarkus 함수 템플릿 구조 링크 복사링크가 클립보드에 복사되었습니다!
Knative(kn) CLI를 사용하여 Quarkus 함수를 생성할 때 프로젝트 디렉터리는 일반적인 Maven 프로젝트와 유사합니다. 또한 이 프로젝트에는 함수 구성에 사용되는 func.yaml 파일이 포함되어 있습니다.
http 및 event 트리거 함수 모두 동일한 템플릿 구조를 갖습니다.
템플릿 구조
- 1
- 이미지 이름과 레지스트리를 결정하는 데 사용됩니다.
- 2
- POM(Project Object Model) 파일에는 종속성에 대한 정보와 같은 프로젝트 구성이 포함되어 있습니다. 이 파일을 수정하여 다른 종속 항목을 추가할 수 있습니다.
추가 종속 항목 예
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 종속성은 첫 번째 컴파일 중에 다운로드됩니다.
- 3
- 함수 프로젝트에는
@Funq주석이 추가된 Java 메서드가 포함되어야 합니다. 이 메서드를Function.java클래스에 배치할 수 있습니다. - 4
- 함수의 로컬 테스트에 사용할 수 있는 간단한 테스트 케이스가 포함되어 있습니다.
12.1.3. Quarkus 함수 호출 정보 링크 복사링크가 클립보드에 복사되었습니다!
클라우드 이벤트에 응답하는 Quarkus 프로젝트 또는 간단한 HTTP 요청에 응답하는 Quarkus 프로젝트를 생성할 수 있습니다. Knative의 클라우드 이벤트는 HTTP를 통해 POST 요청으로 전송되므로 두 기능 유형 모두 들어오는 HTTP 요청을 수신하고 응답할 수 있습니다.
들어오는 요청이 수신되면 Quarkus 함수가 허용된 유형의 인스턴스와 함께 호출됩니다.
| 호출 메소드 | 인스턴스에 포함된 데이터 유형 | 데이터 예 |
|---|---|---|
| HTTP POST 요청 | 요청 본문에 있는 JSON 오브젝트 |
|
| HTTP GET 요청 | 쿼리 문자열의 데이터 |
|
|
|
|
|
다음 예제에서는 이전 표에 나열된 customerId 및 productId 구매 데이터를 수신하고 처리하는 함수를 보여줍니다.
Quarkus 함수의 예
구매 데이터를 포함하는 Purchase JavaBean 클래스는 다음과 같습니다.
클래스 예
public class Purchase {
private long customerId;
private long productId;
// getters and setters
}
public class Purchase {
private long customerId;
private long productId;
// getters and setters
}
12.1.3.1. 호출 예 링크 복사링크가 클립보드에 복사되었습니다!
다음 예제 코드는 withBeans, withCloudEvent, withBinary라는 세 가지 함수를 정의합니다.
예제
Functions 클래스의 withBeans 함수는 다음을 통해 호출할 수 있습니다.
JSON 본문이 있는 HTTP POST 요청:
curl "http://localhost:8080/withBeans" -X POST \ -H "Content-Type: application/json" \ -d '{"message": "Hello there."}'$ curl "http://localhost:8080/withBeans" -X POST \ -H "Content-Type: application/json" \ -d '{"message": "Hello there."}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 쿼리 매개변수가 있는 HTTP GET 요청:
curl "http://localhost:8080/withBeans?message=Hello%20there." -X GET
$ curl "http://localhost:8080/withBeans?message=Hello%20there." -X GETCopy to Clipboard Copied! Toggle word wrap Toggle overflow 바이너리 인코딩의
CloudEvent오브젝트:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 구조화된 인코딩의
CloudEvent오브젝트:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Functions 클래스의 withCloudEvent 함수는 withBeans 함수와 유사하게 CloudEvent 오브젝트를 사용하여 호출할 수 있습니다. 그러나 withBeans와 달리withCloudEvent는 일반 HTTP 요청으로 호출할 수 없습니다.
Functions 클래스의 withBinary 함수는 다음을 통해 호출할 수 있습니다.
바이너리 인코딩의
CloudEvent오브젝트:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 구조화된 인코딩의
CloudEvent오브젝트:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
12.1.4. CloudEvent 속성 링크 복사링크가 클립보드에 복사되었습니다!
type 또는 subject와 같은 CloudEvent의 속성을 읽거나 작성해야 하는 경우 CloudEvent<T> 일반 인터페이스와 CloudEventBuilder 빌더를 사용할 수 있습니다. <T> 유형 매개변수는 허용된 유형 중 하나여야 합니다.
다음 예에서 CloudEventBuilder는 구매 처리 성공 또는 실패를 반환하는 데 사용됩니다.
12.1.5. Quarkus 함수 반환 값 링크 복사링크가 클립보드에 복사되었습니다!
함수는 허용된 유형 목록에서 모든 유형의 인스턴스를 반환할 수 있습니다. 또는 < T> 유형 매개변수가 허용된 유형의 모든 유형일 수 있는 Uni < T > 유형을 반환할 수 있습니다.
Uni<T> 유형은 반환된 오브젝트가 수신된 오브젝트와 동일한 형식으로 직렬화되기 때문에 함수가 비동기 API를 호출할 때 유용합니다. 예를 들면 다음과 같습니다.
- 함수가 HTTP 요청을 수신하면 반환된 오브젝트가 HTTP 응답 본문에 전송됩니다.
-
함수가 바이너리 인코딩으로
CloudEvent오브젝트를 수신하는 경우 반환된 오브젝트는 바이너리 인코딩CloudEvent오브젝트의 데이터 속성으로 전송됩니다.
다음 예제에서는 구매 목록을 가져오는 함수를 보여줍니다.
명령 예
- HTTP 요청을 통해 이 함수를 호출하면 응답 본문에서 구매한 목록을 포함하는 HTTP 응답이 생성됩니다.
-
들어오는
CloudEvent오브젝트를 통해 이 함수를 호출하면data속성에서 구매 목록이 포함된CloudEvent응답이 생성됩니다.
12.1.5.1. 허용된 유형 링크 복사링크가 클립보드에 복사되었습니다!
함수의 입력 및 출력은 void,string 또는 byte[] 유형 중 하나일 수 있습니다. 또한 기본 유형 및 래퍼(예: int 및 Integer )일 수 있습니다. Javabeans, map, lists, arrays, special CloudEvents<T > 유형 등 복잡한 오브젝트일 수도 있습니다.
CloudEvents< > 유형 매개 변수 및 Javabeans의 속성은 여기에 나열된 유형일 수 있습니다.
T > 유형의 맵, 목록, 배열, <T
예
12.1.6. Quarkus 함수 테스트 링크 복사링크가 클립보드에 복사되었습니다!
Quarkus 함수는 컴퓨터에서 로컬로 테스트할 수 있습니다. kn func create 를 사용하여 함수를 생성할 때 생성되는 기본 프로젝트에는 기본 Maven 테스트가 포함된 src/test/ 디렉터리가 있습니다. 이러한 테스트는 필요에 따라 확장할 수 있습니다.
사전 요구 사항
- Quarkus 함수를 생성했습니다.
-
Knative(
kn) CLI가 설치되어 있습니다.
프로세스
- 함수의 프로젝트 폴더로 이동합니다.
Maven 테스트를 실행합니다.
./mvnw test
$ ./mvnw testCopy to Clipboard Copied! Toggle word wrap Toggle overflow
12.1.7. liveness 및 readiness 프로브 값 덮어쓰기 링크 복사링크가 클립보드에 복사되었습니다!
Quarkus 함수의 활성 상태 및 준비 상태 프로브 값을 덮어쓸 수 있습니다. 이를 통해 함수에서 수행된 상태 점검을 구성할 수 있습니다.
사전 요구 사항
- OpenShift Serverless Operator 및 Knative Serving이 클러스터에 설치되어 있습니다.
-
Knative(
kn) CLI가 설치되어 있습니다. -
kn func create를 사용하여 함수를 생성했습니다.
프로세스
/health/liveness및/health/readiness경로를 고유한 값으로 재정의합니다. 함수 소스의 속성을 변경하거나func.yaml파일에서QUARKUS_SMALLRYE_HEALTH_LIVENESS_PATH및QUARKUS_SMALLRYE_HEALTH_READINESS_PATH환경 변수를 설정하여 이 작업을 수행할 수 있습니다.함수 소스를 사용하여 경로를 재정의하려면
src/main/resources/application.properties파일의 경로 속성을 업데이트합니다.quarkus.smallrye-health.root-path=/health quarkus.smallrye-health.liveness-path=alive quarkus.smallrye-health.readiness-path=ready
quarkus.smallrye-health.root-path=/health1 quarkus.smallrye-health.liveness-path=alive2 quarkus.smallrye-health.readiness-path=ready3 Copy to Clipboard Copied! Toggle word wrap Toggle overflow 환경 변수를 사용하여 경로를 재정의하려면
func.yaml파일의build블록에 경로 변수를 정의합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
새 끝점을
func.yaml파일에 추가하여 Knative 서비스의 컨테이너에 올바르게 바인딩됩니다.deploy: healthEndpoints: liveness: /health/alive readiness: /health/readydeploy: healthEndpoints: liveness: /health/alive readiness: /health/readyCopy to Clipboard Copied! Toggle word wrap Toggle overflow