Как перехватить вызов метода в C#?
Для данного класса я хотел бы иметь функцию трассировки, т.е. я хотел бы регистрировать каждый вызов метода (сигнатура метода и фактические значения параметров) и каждый выход метода (только сигнатура метода).
Как мне это сделать, если:
- Я не хочу использовать сторонние библиотеки AOP для C#,
- Я не хочу добавлять дублирующийся код ко всем методам, которые я хочу отследить,
- Я не хочу менять общедоступный API класса - пользователи класса должны иметь возможность вызывать все методы одинаково.
Чтобы сделать вопрос более конкретным, давайте предположим, что есть 3 класса:
public class Caller
{
public static void Call()
{
Traced traced = new Traced();
traced.Method1();
traced.Method2();
}
}
public class Traced
{
public void Method1(String name, Int32 value) { }
public void Method2(Object object) { }
}
public class Logger
{
public static void LogStart(MethodInfo method, Object[] parameterValues);
public static void LogEnd(MethodInfo method);
}
Как вызвать Logger.LogStart и Logger.LogEnd для каждого вызова Method1 и Method2 без изменения метода Caller.Call и без явного добавления вызовов в Traced.Method1 и Traced.Method2?
Изменить: Каково было бы решение, если бы мне позволили немного изменить метод Call?
15 ответов
C# не является AOP-ориентированным языком. Он имеет некоторые функции AOP, и вы можете эмулировать некоторые другие, но создание AOP с C# является болезненным.
Я искал способы сделать именно то, что вы хотели сделать, и я не нашел простого способа сделать это.
Насколько я понимаю, это то, что вы хотите сделать:
[Log()]
public void Method1(String name, Int32 value);
и для этого у вас есть два основных варианта
Унаследуйте свой класс от MarshalByRefObject или ContextBoundObject и определите атрибут, который наследуется от IMessageSink. Эта статья имеет хороший пример. Тем не менее, вы должны учитывать, что при использовании MarshalByRefObject производительность будет падать до чертиков, и я имею в виду, я говорю о 10-кратной потере производительности, поэтому подумайте, прежде чем пытаться это делать.
Другой вариант - ввести код напрямую. Во время выполнения это означает, что вам придется использовать отражение, чтобы "читать" каждый класс, получать его атрибуты и вводить соответствующий вызов (и в этом отношении я думаю, что вы не можете использовать метод Reflection.Emit, так как я думаю, что Reflection.Emit не не позволяет вставлять новый код в уже существующий метод). Во время разработки это будет означать создание расширения для компилятора CLR, которое я, честно говоря, понятия не имею, как это делается.
Последний вариант - использование инфраструктуры IoC. Возможно, это не идеальное решение, так как большинство IoC-фреймворков работают путем определения точек входа, которые позволяют подключать методы, но, в зависимости от того, чего вы хотите достичь, это может быть справедливым приближением.
Самый простой способ добиться этого - использовать PostSharp. Он внедряет код в ваши методы на основе атрибутов, которые вы к нему применяете. Это позволяет вам делать именно то, что вы хотите.
Другой вариант - использовать API профилирования для внедрения кода внутри метода, но это действительно хардкор.
Если вы напишите класс - назовите его Tracing - который реализует интерфейс IDisposable, вы можете обернуть все тела метода в
Using( Tracing tracing = new Tracing() ){ ... method body ...}
В классе Tracing вы можете обрабатывать логику трассировки в конструкторе / методе Dispose, соответственно, в классе Tracing, чтобы отслеживать вход и выход из методов. Такой что:
public class Traced
{
public void Method1(String name, Int32 value) {
using(Tracing tracer = new Tracing())
{
[... method body ...]
}
}
public void Method2(Object object) {
using(Tracing tracer = new Tracing())
{
[... method body ...]
}
}
}
Этого можно добиться с помощью функции перехвата DI-контейнера, такого как Castle Windsor. Действительно, можно настроить контейнер таким образом, чтобы перехватывались все классы, у которых есть метод, декорированный определенным атрибутом.
Что касается пункта № 3, OP запросил решение без AOP Framework. В следующем ответе я предположил, что следует избегать Aspect, JointPoint, PointCut и т. Д. Согласно документации по перехвату от CastleWindsor, ни один из них не требуется для выполнения запрошенного.
Настройте общую регистрацию Перехватчика, основываясь на наличии атрибута:
public class RequireInterception : IContributeComponentModelConstruction
{
public void ProcessModel(IKernel kernel, ComponentModel model)
{
if (HasAMethodDecoratedByLoggingAttribute(model.Implementation))
{
model.Interceptors.Add(new InterceptorReference(typeof(ConsoleLoggingInterceptor)));
model.Interceptors.Add(new InterceptorReference(typeof(NLogInterceptor)));
}
}
private bool HasAMethodDecoratedByLoggingAttribute(Type implementation)
{
foreach (var memberInfo in implementation.GetMembers())
{
var attribute = memberInfo.GetCustomAttributes(typeof(LogAttribute)).FirstOrDefault() as LogAttribute;
if (attribute != null)
{
return true;
}
}
return false;
}
}
Добавьте созданную IContributeComponentModelConstruction в контейнер
container.Kernel.ComponentModelBuilder.AddContributor(new RequireInterception());
И вы можете делать все, что вы хотите в самом перехватчике
public class ConsoleLoggingInterceptor : IInterceptor
{
public void Intercept(IInvocation invocation)
{
Console.Writeline("Log before executing");
invocation.Proceed();
Console.Writeline("Log after executing");
}
}
Добавьте атрибут logging в ваш метод для регистрации
public class Traced
{
[Log]
public void Method1(String name, Int32 value) { }
[Log]
public void Method2(Object object) { }
}
Обратите внимание, что некоторая обработка атрибута потребуется, если только какой-то метод класса должен быть перехвачен. По умолчанию все открытые методы будут перехвачены.
Если вы хотите отслеживать ваши методы без ограничений (без адаптации кода, без AOP Framework, без дублированного кода), позвольте мне сказать вам, вам нужно немного магии...
Серьезно, я решил внедрить AOP Framework, работающий во время выполнения.
Вы можете найти здесь: NConcern.NET AOP Framework
Я решил создать эту AOP Framework, чтобы дать ответ на такие потребности. это простая библиотека, очень легкая. Вы можете увидеть пример регистратора на домашней странице.
Если вы не хотите использовать стороннюю сборку, вы можете просмотреть исходный код (с открытым исходным кодом) и скопировать оба файла Aspect.Directory.cs и Aspect.Directory.Entry.cs в соответствии с вашими пожеланиями. Эти классы позволяют заменять ваши методы во время выполнения. Я бы просто попросил вас уважать лицензию.
Я надеюсь, что вы найдете то, что вам нужно, или убедите вас, наконец, использовать AOP Framework.
Я нашел другой способ, который может быть проще...
Объявите метод InvokeMethod
[WebMethod]
public object InvokeMethod(string methodName, Dictionary<string, object> methodArguments)
{
try
{
string lowerMethodName = '_' + methodName.ToLowerInvariant();
List<object> tempParams = new List<object>();
foreach (MethodInfo methodInfo in serviceMethods.Where(methodInfo => methodInfo.Name.ToLowerInvariant() == lowerMethodName))
{
ParameterInfo[] parameters = methodInfo.GetParameters();
if (parameters.Length != methodArguments.Count()) continue;
else foreach (ParameterInfo parameter in parameters)
{
object argument = null;
if (methodArguments.TryGetValue(parameter.Name, out argument))
{
if (parameter.ParameterType.IsValueType)
{
System.ComponentModel.TypeConverter tc = System.ComponentModel.TypeDescriptor.GetConverter(parameter.ParameterType);
argument = tc.ConvertFrom(argument);
}
tempParams.Insert(parameter.Position, argument);
}
else goto ContinueLoop;
}
foreach (object attribute in methodInfo.GetCustomAttributes(true))
{
if (attribute is YourAttributeClass)
{
RequiresPermissionAttribute attrib = attribute as YourAttributeClass;
YourAttributeClass.YourMethod();//Mine throws an ex
}
}
return methodInfo.Invoke(this, tempParams.ToArray());
ContinueLoop:
continue;
}
return null;
}
catch
{
throw;
}
}
Затем я определяю свои методы так
[WebMethod]
public void BroadcastMessage(string Message)
{
//MessageBus.GetInstance().SendAll("<span class='system'>Web Service Broadcast: <b>" + Message + "</b></span>");
//return;
InvokeMethod("BroadcastMessage", new Dictionary<string, object>() { {"Message", Message} });
}
[RequiresPermission("editUser")]
void _BroadcastMessage(string Message)
{
MessageBus.GetInstance().SendAll("<span class='system'>Web Service Broadcast: <b>" + Message + "</b></span>");
return;
}
Теперь я могу иметь проверку во время выполнения без внедрения зависимости...
Нет ошибок в сайте:)
Надеемся, вы согласитесь, что это меньше веса, чем AOP Framework или происходит от MarshalByRefObject или с использованием классов удаленного взаимодействия или прокси-классов.
Взгляните на это - довольно тяжелые вещи.. http://msdn.microsoft.com/en-us/magazine/cc164165.aspx
Essential.net - don box имел главу о том, что вам нужно, называется Перехват. Я кое-что здесь почистил (извините за цвета шрифта - тогда у меня была темная тема...) http://madcoderspeak.blogspot.com/2005/09/essential-interception-using-contexts.html
Сначала вы должны изменить свой класс для реализации интерфейса (а не реализации MarshalByRefObject).
interface ITraced {
void Method1();
void Method2()
}
class Traced: ITraced { .... }
Затем вам понадобится универсальный объект-обертка, основанный на RealProxy, для украшения любого интерфейса, позволяющего перехватывать любые вызовы декорированного объекта.
class MethodLogInterceptor: RealProxy
{
public MethodLogInterceptor(Type interfaceType, object decorated)
: base(interfaceType)
{
_decorated = decorated;
}
public override IMessage Invoke(IMessage msg)
{
var methodCall = msg as IMethodCallMessage;
var methodInfo = methodCall.MethodBase;
Console.WriteLine("Precall " + methodInfo.Name);
var result = methodInfo.Invoke(_decorated, methodCall.InArgs);
Console.WriteLine("Postcall " + methodInfo.Name);
return new ReturnMessage(result, null, 0,
methodCall.LogicalCallContext, methodCall);
}
}
Теперь мы готовы перехватывать вызовы Method1 и Method2 ITraced.
public class Caller
{
public static void Call()
{
ITraced traced = (ITraced)new MethodLogInterceptor(typeof(ITraced), new Traced()).GetTransparentProxy();
traced.Method1();
traced.Method2();
}
}
Вы можете использовать фреймворк с открытым исходным кодом CInject на CodePlex. Вы можете написать минимальный код для создания Инжектора и заставить его быстро перехватывать любой код с помощью CInject. Плюс, поскольку это Open Source, вы можете расширить это.
Или вы можете выполнить шаги, упомянутые в этой статье, по перехвату вызовов методов с использованием IL и создать свой собственный перехватчик с использованием классов Reflection.Emit в C#.
Я не знаю решения, но мой подход был бы следующим.
Украсьте класс (или его методы) пользовательским атрибутом. Где-то еще в программе, пусть функция инициализации отражает все типы, читает методы, украшенные атрибутами, и вводит некоторый код IL в метод. На самом деле может быть более практичным заменить метод заглушкой, которая вызывает LogStart, фактический метод, а затем LogEnd, Кроме того, я не знаю, можете ли вы изменить методы, используя отражение, так что может быть более практичным заменить весь тип.
AOP является обязательным условием для реализации чистого кода, однако, если вы хотите заключить блок в C#, универсальные методы имеют относительно более простое использование. (с интеллигентным смыслом и строго типизированным кодом) Конечно, это НЕ может быть альтернативой для АОП.
Хотя PostSHarp имеет небольшие проблемы с ошибками (я не чувствую уверенности в использовании на производстве), это хороший материал.
Общий класс обертки,
public class Wrapper
{
public static Exception TryCatch(Action actionToWrap, Action<Exception> exceptionHandler = null)
{
Exception retval = null;
try
{
actionToWrap();
}
catch (Exception exception)
{
retval = exception;
if (exceptionHandler != null)
{
exceptionHandler(retval);
}
}
return retval;
}
public static Exception LogOnError(Action actionToWrap, string errorMessage = "", Action<Exception> afterExceptionHandled = null)
{
return Wrapper.TryCatch(actionToWrap, (e) =>
{
if (afterExceptionHandled != null)
{
afterExceptionHandled(e);
}
});
}
}
использование может быть таким (с интеллигентным смыслом, конечно)
var exception = Wrapper.LogOnError(() =>
{
MessageBox.Show("test");
throw new Exception("test");
}, "Hata");
Вам нужно уговорить Айенде за ответ о том, как он это сделал: http://ayende.com/Blog/archive/2009/11/19/can-you-hack-this-out.aspx
Вы могли бы потенциально использовать GOF Decorator Pattern и "декорировать" все классы, которые нуждаются в трассировке.
Вероятно, это действительно практично только с контейнером IOC (но, как указывалось ранее, вы можете рассмотреть возможность перехвата метода, если собираетесь идти по пути IOC).
Может быть, уже слишком поздно для этого ответа, но вот оно.
То, чего вы хотите достичь, встроено в библиотеку MediatR.
Это мой RequestLoggerBehaviour, который перехватывает все вызовы моего бизнес-уровня.
namespace SmartWay.Application.Behaviours
{
public class RequestLoggerBehaviour<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
{
private readonly ILogger _logger;
private readonly IAppSession _appSession;
private readonly ICreateLogGrain _createLogGrain;
public RequestLoggerBehaviour(ILogger<TRequest> logger, IAppSession appSession, IClusterClient clusterClient)
{
_logger = logger;
_appSession = appSession;
_createLogGrain = clusterClient.GetGrain<ICreateLogGrain>(Guid.NewGuid());
}
public async Task<TResponse> Handle(TRequest request, CancellationToken cancellationToken, RequestHandlerDelegate<TResponse> next)
{
var name = typeof(TRequest).Name;
_logger.LogInformation($"SmartWay request started: ClientId: {_appSession.ClientId} UserId: {_appSession.UserId} Operation: {name} Request: {request}");
var response = await next();
_logger.LogInformation($"SmartWay request ended: ClientId: {_appSession.ClientId} UserId: {_appSession.UserId} Operation: {name} Request: {request}");
return response;
}
}
}
Вы также можете создать поведение производительности, например, для отслеживания методов, выполнение которых занимает слишком много времени.
Наличие чистой архитектуры (MediatR) на вашем бизнес-уровне позволит вам сохранить ваш код в чистоте, пока вы применяете принципы SOLID.
Вы можете увидеть, как это работает, здесь:https://youtu.be/5OtUm1BLmG0?t=1
- Напишите свою собственную библиотеку АОП.
- Используйте отражение, чтобы сгенерировать прокси-сервер журналирования для ваших экземпляров (не уверен, что вы можете сделать это без изменения какой-либо части существующего кода).
- Перепишите сборку и введите код регистрации (в основном такой же, как 1).
- Разместите CLR и добавьте протоколирование на этом уровне (я думаю, что это самое сложное решение для реализации, хотя я не уверен, что у вас есть необходимые хуки в CLR).
Лучшее, что вы можете сделать до выхода C# 6 с именем nameof - это использовать медленные выражения StackTrace и linq.
Например, для такого метода
public void MyMethod(int age, string name)
{
log.DebugTrace(() => age, () => name);
//do your stuff
}
Такая строка может быть выдана в вашем лог-файле
Method 'MyMethod' parameters age: 20 name: Mike
Вот реализация:
//TODO: replace with 'nameof' in C# 6
public static void DebugTrace(this ILog log, params Expression<Func<object>>[] args)
{
#if DEBUG
var method = (new StackTrace()).GetFrame(1).GetMethod();
var parameters = new List<string>();
foreach(var arg in args)
{
MemberExpression memberExpression = null;
if (arg.Body is MemberExpression)
memberExpression = (MemberExpression)arg.Body;
if (arg.Body is UnaryExpression && ((UnaryExpression)arg.Body).Operand is MemberExpression)
memberExpression = (MemberExpression)((UnaryExpression)arg.Body).Operand;
parameters.Add(memberExpression == null ? "NA" : memberExpression.Member.Name + ": " + arg.Compile().DynamicInvoke().ToString());
}
log.Debug(string.Format("Method '{0}' parameters {1}", method.Name, string.Join(" ", parameters)));
#endif
}