My<cod/>.net
Как передать перечисленные значения в веб-службу
Моя дилемма заключается, в основном, в том, как разделить перечисление между двумя приложениями.
Пользователи загружают документы через интерфейсное приложение, которое находится в интернете. Это приложение вызывает веб-службу внутреннего приложения и передает ему документ. Серверное приложение сохраняет документ и вставляет строку в таблицу документов .
Тип документа (7 возможных типов документов: счет- фактура, договор и т.д.) передается в качестве параметра в метод UploadDocument веб-службы. Вопрос в том, каким должен быть тип (и возможные значения) этого параметра?
Поскольку вам нужно жестко закодировать эти значения в обоих приложениях, я думаю, что это O.K. чтобы использовать описательную строку (счет, контракт, WorkOrder , SignedWorkOrder).
Может быть, лучше создать перечисление DocumentTypes в первом приложении и воспроизвести его также во втором приложении, а затем передать соответствующее целочисленное значение веб-службе между ними?
Я бы предложил не передавать целое число между ними, просто для удобства чтения и отладки. Допустим, вы просматриваете свои журналы и видите кучу из 500 ошибок для DocumentType=4. Теперь вы должны пойти и посмотреть, какой DocumentType равен 4. Или если одно из приложений ссылается на число, которое не существует в другом, возможно, из-за несовпадения версий.
Это немного больше кода, и он немного натирает статическую печатающую часть мозга, но в протоколах поверх HTTP принятая мудрость заключается в том, чтобы встать на сторону разборчивых строк над непрозрачными перечислениями.
Я все равно буду использовать перечисление внутренне, но ожидал бы, что потребители передадут мне только имя, а не само числовое значение.
просто какой-то глупый пример для иллюстрации:
public enum DocumentType
{
Invoice,
Contract,
WorkOrder,
SignedWorkOrder
}
[WebMethod]
public void UploadDocument(string type, byte[] data)
{
DocumentType docType = (DocumentType)Enum.Parse(typeof(DocumentType), type);
}
Я могу говорить только о .net, но если у вас есть веб-сервис ASP.net, вы должны быть в состоянии добавить перечисление непосредственно к нему.
Когда вы затем используете "Add Web Reference" в своем клиентском приложении, результирующий класс должен включать это перечисление
Но это с моей точки зрения, я почти уверен, что делал это в прошлом, но я не могу сказать наверняка.
В .NET значения перечисления (по умолчанию) сериализуются в xml с именем. Для случаев, когда вы можете иметь несколько значений (флагов), то он помещает пробел между значениями. Это работает, потому что перечисление не содержит пробелов, поэтому вы можете получить значение снова, разделив строку (т. е. "Контракт счета-фактуры SignedWorkOrder", используя пример любоса).
Вы можете контролировать сериализации значений в веб-asp.net услуг с использованием XmlEnumAttribute , EnumMember или с помощью атрибута при использовании WCF.
Если вы не работаете с .NET до .NET SOAP, вы все равно можете определить перечислитель, если обе конечные точки используют WSDL.
<s:simpleType name="MyEnum">
<s:restriction base="s:string">
<s:enumeration value="Wow"/>
<s:enumeration value="This"/>
<s:enumeration value="Is"/>
<s:enumeration value="Really"/>
<s:enumeration value="Simple"/>
</s:restriction>
</s:simpleType>
Его до инструмента WSDL - > Proxy generator разобрать, что в перечисление эквивалент на языке клиента.
Есть несколько довольно веских причин для того, чтобы не использовать enum s на такой границе интерфейса. Рассмотрим сообщение дэра на эту тему.
Я заметил, что при использовании "Add Service Reference" в отличие от "Add Web Reference" из VS.net, фактические значения перечисления встречаются так же, как и имена перечислений. Это действительно раздражает, так как мне нужно поддерживать как 2.0, так и 3.5 клиентов. Я заканчиваю тем, что должен войти в созданный 2.0 прокси-код веб-службы и вручную добавлять значения перечисления каждый раз, когда я делаю изменение!