서비스 작업(WCF Data Services)

WCF Data Services를 사용하면 데이터 서비스에 서버의 메서드를 노출하는 서비스 작업을 정의할 수 있습니다. 다른 데이터 서비스 리소스와 마찬가지로 서비스 작업도 URI로 주소가 지정됩니다. 서비스 작업을 사용하면 유효성 검사 논리 구현, 역할 기반 보안 적용 또는 특수 쿼리 기능 노출 등을 위해 데이터 서비스에 비즈니스 논리를 노출할 수 있습니다. 서비스 작업은 DataService<T>에서 파생되는 데이터 서비스 클래스에 추가되는 메서드입니다. 다른 데이터 서비스 리소스와 마찬가지로, 서비스 작업 메서드에 매개 변수를 제공할 수 있습니다. 예를 들어 다음 서비스 작업 URI(quickstart 데이터 서비스에 기반)는 값 London을 city 매개 변수로 전달합니다.

https://localhost:12345/Northwind.svc/GetOrdersByCity?city='London'

이 서비스 작업의 정의는 다음과 같습니다.

<WebGet()> _
Public Function GetOrdersByCity(ByVal city As String) As IQueryable(Of Order)

[WebGet]
public IQueryable<Order> GetOrdersByCity(string city)

DataService<T>의 CurrentDataSource를 사용하여 데이터 서비스에서 사용하는 데이터 소스에 직접 액세스할 수 있습니다. 자세한 내용은 방법: 서비스 작업 정의(WCF Data Services)을 참조하십시오.

.NET Framework 클라이언트 응용 프로그램에서 서비스 작업을 호출하는 방법은 서비스 작업 및 동작 호출(WCF Data Services)을 참조하십시오.

서비스 작업 요구 사항

데이터 서비스에 서비스 작업을 정의할 때 적용되는 요구 사항은 다음과 같습니다. 이러한 요구 사항을 충족하지 않는 메서드는 데이터 서비스의 서비스 작업으로 노출되지 않습니다.

• 작업은 데이터 서비스 클래스의 멤버인 공용 인스턴스 메서드여야 합니다.

• 작업 메서드는 입력 매개 변수만 허용할 수 있습니다. 메시지 본문에 전송되는 데이터는 데이터 서비스가 액세스할 수 없습니다.

• 매개 변수를 정의할 때 각 매개 변수의 형식은 기본 형식이어야 합니다. 기본이 아닌 형식의 모든 데이터는 serialize한 다음 문자열 매개 변수로 전달해야 합니다.

• 메서드는 다음 중 하나를 반환해야 합니다.

  • void(Visual Basic에서는 Nothing)

  • IEnumerable<T>

  • IQueryable<T>

  • 데이터 서비스에서 노출하는 데이터 모델의 엔터티 형식

  • 정수 또는 문자열과 같은 기본 클래스

• 정렬, 페이징, 필터링 등의 쿼리 옵션을 지원하려면 서비스 작업 메서드가 IQueryable<T>을 반환해야 합니다. IEnumerable<T>만 반환하는 작업의 경우 쿼리 옵션을 포함하는 서비스 작업 요청이 거부됩니다.

• 탐색 속성을 사용하여 관련 엔터티에 액세스할 수 있도록 지원하려면 서비스 작업이 IQueryable<T>을 반환해야 합니다.

• [WebGet] 또는 [WebInvoke] 특성을 메서드에 주석으로 추가해야 합니다.

  • [WebGet]을 사용하면 GET 요청을 통해 메서드를 호출할 수 있습니다.

  • [WebInvoke(Method = "POST")]을 사용하면 POST 요청을 통해 메서드를 호출할 수 있습니다. 다른 WebInvokeAttribute 메서드는 지원 되지 않습니다.

• 메서드의 반환 값이 엔터티 컬렉션이 아니라 단일 엔터티가 되도록 지정하는 SingleResultAttribute를 서비스 작업에 주석으로 추가할 수도 있습니다. 이 특성은 응답의 결과 serialization과 추가 탐색 속성 통과가 URI에 표시되는 방식을 제어합니다. 예를 들어, AtomPub serialization을 사용할 경우 단일 리소스 형식 인스턴스는 항목 요소로 표시되고 인스턴스 집합은 피드 요소로 표시됩니다.

서비스 작업 주소 지정

URI의 첫 번째 경로 세그먼트에 메서드 이름을 배치하여 서비스 작업의 주소를 지정할 수 있습니다. 예를 들어, 다음 URI은 Orders 개체의 IQueryable<T> 컬렉션을 반환하는 GetOrdersByState 작업에 액세스합니다.

https://localhost:12345/Northwind.svc/GetOrdersByState?state='CA'&includeItems=true

서비스 작업을 호출할 때 매개 변수는 쿼리 옵션으로 제공됩니다. 이전 서비스 작업은 문자열 매개 변수 state와 관련 Order_Detail 개체를 응답에 포함해야 하는지 여부를 나타내는 부울 매개 변수 includeItems 둘 다를 허용합니다.

서비스 작업에 대해 유효한 반환 형식은 다음과 같습니다.

서비스 작업의 반환 형식에 따라 추가 경로 세그먼트나 쿼리 옵션이 URI에 추가될 수도 있습니다. 예를 들어, 다음 URI는 관련된 Order_Details 개체와 함께 Orders 개체의 IQueryable<T> 컬렉션을 RequiredDate의 내림차순으로 정렬하여 반환하는 GetOrdersByCity 작업에 액세스합니다.

https://localhost:12345/Northwind.svc/GetOrdersByCity?city='London'&$expand=Order_Details&$orderby=RequiredDate desc

서비스 작업 액세스 제어

서비스 전반에 걸친 서비스 작업의 표시는 IDataServiceConfiguration 클래스의 SetServiceOperationAccessRule 메서드에 의해 제어되며, 이는 엔터티 집합의 표시가 SetEntitySetAccessRule 메서드를 사용하여 제어되는 방식과 상당 부분 유사합니다. 예를 들어, 데이터 서비스 정의의 다음 코드 줄은 CustomersByCity 서비스 작업에 액세스할 수 있도록 합니다.

config.SetServiceOperationAccessRule( _
    "GetOrdersByCity", ServiceOperationRights.AllRead)

config.SetServiceOperationAccessRule(
    "GetOrdersByCity", ServiceOperationRights.AllRead);

자세한 내용은 방법: 서비스 작업 정의(WCF Data Services)를 참조하십시오.

예외 발생

데이터 서비스 실행에서 예외를 발생시킬 때마다 DataServiceException 클래스를 사용하는 것이 좋습니다. 그 이유는 데이터 서비스 런타임이 이 예외 개체의 속성을 HTTP 응답 메시지에 올바르게 매핑하는 방법을 알기 때문입니다. 서비스 작업에서 DataServiceException을 발생시키면 반환된 예외가 TargetInvocationException으로 래핑됩니다. TargetInvocationException을 묶지 않고 기본 DataServiceException을 반환하려면 다음 예제와 같이 DataService<T>에 HandleException(HandleExceptionArgs) 메서드를 재정의하고 TargetInvocationException에서 DataServiceException을 추출해서 최상위 오류로 반환해야 합니다.

' Override to manage returned exceptions.
Protected Overrides Sub HandleException(args As HandleExceptionArgs)
    ' Handle exceptions raised in service operations.
    If args.Exception.GetType() = GetType(TargetInvocationException) _
        AndAlso args.Exception.InnerException IsNot Nothing Then
        If args.Exception.InnerException.GetType() = GetType(DataServiceException) Then
            ' Unpack the DataServiceException.
            args.Exception = _
                TryCast(args.Exception.InnerException, DataServiceException)
        Else
            ' Return a new DataServiceException as "400: bad request."
            args.Exception = _
                New DataServiceException(400, args.Exception.InnerException.Message)
        End If
    End If
End Sub

// Override to manage returned exceptions.
protected override void HandleException(HandleExceptionArgs args)
{
    // Handle exceptions raised in service operations.
    if (args.Exception.GetType() ==
        typeof(TargetInvocationException)
        && args.Exception.InnerException != null)
    {
        if (args.Exception.InnerException.GetType()
            == typeof(DataServiceException))
        {

            // Unpack the DataServiceException.
            args.Exception = args.Exception.InnerException as DataServiceException;

        }
        else
        {
            // Return a new DataServiceException as "400: bad request."
            args.Exception =
                new DataServiceException(400,
                    args.Exception.InnerException.Message);
        }
    }
}

참고 항목

개념

인터셉터(WCF Data Services)