Принудительное оформление атрибутов классов / методов
Исходя из моего недавнего вопроса о больших, сложных объектах как результат веб-службы. Я думал о том, как обеспечить, чтобы все будущие дочерние классы были сериализуемыми в XML.
Теперь, очевидно, я мог бы реализовать интерфейс IXmlSerializable, а затем привязать к нему читателя / писателя, но я бы хотел этого избежать, так как тогда это означает, что мне нужно создавать экземпляр читателя / писателя всякий раз, когда я хочу это делать, и в 99,99% случаев Я собираюсь работать со строкой, поэтому я могу написать свою собственную.
Однако, чтобы сериализовать в XML, я просто украшаю класс и его членов Xml??? атрибуты (XmlRoot, XmlElement и т. д.), а затем передают их в XmlSerializer и StringWriter для получения строки. Что все хорошо. Я намереваюсь поместить метод для возврата строки в универсальный служебный метод, поэтому мне не нужно беспокоиться о типе и т. Д.
Это то, что меня беспокоит: если я не украшаю класс (ы) необходимыми атрибутами, ошибка не выдается до времени выполнения.
Есть ли способ принудительного оформления атрибутов? Можно ли это сделать с помощью FxCop? (Я еще не использовал FxCop)
ОБНОВИТЬ:
Извините за задержку с этим, ребята, много работы!
Определенно, как идея использовать отражение, чтобы сделать это в тестовом примере, а не прибегать к FxCop (например, чтобы держать все вместе). Ответ Фредрика Калсета был фантастическим, спасибо за включение кода, так как это, вероятно, заняло бы у меня немного копаний выяснить, как это сделать самому!
+1 другим парням за подобные предложения:)
5 ответов
Я бы написал единичный / интеграционный тест, который проверяет, что любой класс, соответствующий некоторым заданным критериям (т.е. подкласс X), оформлен соответствующим образом. Если вы настроили сборку для запуска с тестами, вы можете потерпеть неудачу при сбое теста.
ОБНОВЛЕНИЕ: Вы сказали: "Похоже, мне просто придется закатать рукава и убедиться, что юнит-тесты собраны вместе" - вам не нужно. Просто напишите общий тестовый класс, который использует отражение, чтобы найти все классы, которые должны быть утверждены. Что-то вроде этого:
[TestClass]
public class When_type_inherits_MyObject
{
private readonly List<Type> _types = new List<Type>();
public When_type_inherits_MyObject()
{
// lets find all types that inherit from MyObject, directly or indirectly
foreach(Type type in typeof(MyObject).Assembly.GetTypes())
{
if(type.IsClass && typeof(MyObject).IsAssignableFrom(type))
{
_types.Add(type);
}
}
}
[TestMethod]
public void Properties_have_XmlElement_attribute
{
foreach(Type type in _types)
{
foreach(PropertyInfo property in type.GetProperties())
{
object[] attribs = property.GetCustomAttributes(typeof(XmlElementAttribute), false);
Assert.IsTrue(attribs.Count > 0, "Missing XmlElementAttribute on property " + property.Name + " in type " + type.FullName);
}
}
}
}
Вы можете написать правило FxCop или даже проверить атрибуты, вызвав GetType() в конструкторе базового класса и размышляя над возвращаемым типом.
Вы можете написать модульные тесты для проверки такого рода вещей - они в основном используют рефлексию.
Учитывая тот факт, что это возможно, я думаю, что было бы также возможно написать правило FxCop, но я никогда не делал такого.
Хорошее правило FXCop (и которое я нахожу нужным прямо сейчас) должно заключаться в проверке того, что все объекты, добавляемые в сеанс ASP.NET, имеют атрибут Serializable. Я пытаюсь перейти из состояния сеанса InProc в SQL Server. Когда я впервые запросил страницу, мой сайт взорвался, потому что в Session хранились несериализуемые объекты. Затем возникла задача поиска по всему исходному коду и поиска каждого экземпляра, в котором объект установлен в сеансе... FXCop было бы хорошим решением. Над чем поработать...
Вы также можете использовать эту концепцию / постпроцессор для обеспечения взаимосвязей между атрибутами и использовать аналогичный вход в систему для обеспечения взаимосвязей между классами и атрибутами во время компиляции:
http://www.st.informatik.tu-darmstadt.de/database/publications/data/cepa-mezini-gpce04.pdf?id=92