Буферы протоколов в проектах c# с использованием protobuf-net-рекомендации по генерации кода
Я пытаюсь использовать protobuf в проекте C#, используя protobuf-net, и мне интересно, как лучше всего организовать это в структуру проекта Visual Studio.
при ручном использовании инструмента protogen для генерации кода на C# жизнь кажется легкой, но она не кажется правильной.
Я бы хотел .файл proto следует рассматривать как основной файл исходного кода, генерирующий файлы C# в качестве побочного продукта, но до того, как компилятор C# будет вовлечен.
параметры вроде бы:
- пользовательский инструмент для proto tools (хотя я не вижу, с чего начать)
- шаг предварительной сборки (вызов protogen или пакетного файла, который это делает)
я боролся с 2) выше, поскольку он продолжает давать мне "система не может найти указанный файл", если я не использую абсолютные пути (и мне не нравится заставлять проекты быть явно расположены).
существует ли конвенция (пока) для это?
Edit: Основываясь на комментариях @jon, я повторил метод шага предварительной сборки и использовал это (местоположение protogen жестко закодировано на данный момент), используя пример адресной книги Google:
c:binprotobufprotogen "-i:$(ProjectDir)AddressBook.proto"
"-o:$(ProjectDir)AddressBook.cs" -t:c:binprotobufcsharp.xslt
Edit2: Принимая рекомендацию @jon, чтобы минимизировать время сборки, не обрабатывая .файлы proto если они не изменились, я собрал базовый инструмент для проверки для меня (это, вероятно, может быть расширено до полного инструмента пользовательской сборки):
using System;
using System.Diagnostics;
using System.IO;
namespace PreBuildChecker
{
public class Checker
{
static int Main(string[] args)
{
try
{
Check(args);
return 0;
}
catch (Exception e)
{
Console.WriteLine(e.Message);
return 1;
}
}
public static void Check(string[] args)
{
if (args.Length < 3)
{
throw new ArgumentException(
"Command line must be supplied with source, target and command-line [plus options]");
}
string source = args[0];
string target = args[1];
string executable = args[2];
string arguments = args.Length > 3 ? GetCommandLine(args) : null;
FileInfo targetFileInfo = new FileInfo(target);
FileInfo sourceFileInfo = new FileInfo(source);
if (!sourceFileInfo.Exists)
{
throw new ArgumentException(string.Format(
"Source file {0} not found", source));
}
if (!targetFileInfo.Exists ||
sourceFileInfo.LastWriteTimeUtc > targetFileInfo.LastAccessTimeUtc)
{
Process process = new Process();
process.StartInfo.FileName = executable;
process.StartInfo.Arguments = arguments;
process.StartInfo.ErrorDialog = true;
Console.WriteLine(string.Format(
"Source newer than target, launching tool: {0} {1}",
executable,
arguments));
process.Start();
}
}
private static string GetCommandLine(string[] args)
{
string[] arguments = new string[args.Length - 3];
Array.Copy(args, 3, arguments, 0, arguments.Length);
return String.Join(" ", arguments);
}
}
}
моя команда предварительной сборки теперь (все в одной строке):
$(SolutionDir)PreBuildChecker$(OutDir)PreBuildChecker
$(ProjectDir)AddressBook.proto
$(ProjectDir)AddressBook.cs
c:binprotobufprotogen
"-i:$(ProjectDir)AddressBook.proto"
"-o:$(ProjectDir)AddressBook.cs"
-t:c:binprotobufcsharp.xslt
6 ответов
в качестве расширения кода Шона я рад сообщить, что protobuf-net теперь имеет интеграцию Visual Studio с помощью пользовательского инструмента. Установщик msi доступен из страница проекта. Более полная информация здесь: protobuf-net; теперь с добавленными косатками.
вызов шага предварительной сборки, но использование переменных проекта (например,$(ProjectPath)
) для создания абсолютных имен файлов без их фактического наличия в вашем решении казалось бы разумной ставкой для меня.
одна вещь, которую вы могли бы рассмотреть, основываясь на моем прошлом опыте генераторов кода: Вы можете написать оболочку для protogen, которая генерирует код в другое место, а затем проверяет, является ли вновь сгенерированный код таким же, как старый код, и не перезаписывает его, если это так. Что способ Visual Studio поймет, что ничего не изменилось, и не заставит этот проект Быть перестроенным-это сократило время сборки резко для меня в прошлом.
кроме того, вы можете сохранить хэш md5.proto файл в последний раз protogen был выполнен, и только выполнить protogen, если .файл proto изменился-еще меньше делать на каждой сборке!
Спасибо за поднятие этого вопроса, хотя-это явно предполагает, что я должен разработать способ сделать это легкий шаг предварительной сборки для моего собственного порта.
добавьте следующее событие предварительной сборки в настройки проекта, чтобы создать файл c# только тогда, когда.файл proto изменился. Просто замените YourFile
на имя имя вашего .прото файл.
cd $(ProjectDir) && powershell -Command if (!(Test-Path YourFile.proto.cs) -or (Get-Item YourFile.proto).LastWriteTimeUtc -gt (Get-Item YourFile.proto.cs).LastWriteTimeUtc) { PathToProtoGen\protogen -i:YourFile.proto -o:YourFile.proto.cs }
это работает в любой последней версии Visual Studio, в отличие от protobuf-net Custom-Build tool, который не поддерживает Visual Studio 2012 или Visual Studio 2013, в соответствии с проблемами 338 и 413.
ну, это дало мне идею (что-то о изобретении колеса)...
- создать простой Makefile.МАК, Что-то вроде
.SUFFIXES : .cs .proto .proto.cs: protogen\protogen.exe -i:$? -o:$@ -t:protogen\csharp.xlst
(очевидно, не забудьте заменить пути к протогену и csharp.xlst). важно-Протоген\protogen.команда exe, начиная с символа вкладки, а не 8 пробелов
- если вы не хотите указывать файлы, необходимые для сборки все время, вы можете использовать что-то как
.SUFFIXES : .cs .proto all: mycs1.cs myotherfile.cs .proto.cs: protogen\protogen.exe -i:$? -o:$@ -t:protogen\csharp.xlst
- в шаге предварительной сборки добавить
cd $(ProjectDir) && "$(DevEnvDir)..\..\vc\bin\nmake" /NOLOGO -c -f Makefile.mak mycs1.cs myotherfile.cs
или, если у вас есть nmake на вашем пути, можно использовать
cd $(ProjectDir) && nmake /NOLOGO -c -f Makefile.mak mycs1.cs myotherfile.cs
добавить в соответствующий файл проекта.
преимущество, инкрементная сборка.
недостаток, нужно редактировать вручную при добавлении файлов.
<ItemGroup>
<Proto Include="Person.proto" />
<Compile Include="Person.cs">
<DependentUpon>Person.proto</DependentUpon>
</Compile>
</ItemGroup>
<PropertyGroup>
<CompileDependsOn>ProtobufGenerate;$(CompileDependsOn)</CompileDependsOn>
</PropertyGroup>
<Target Name="ProtobufGenerate" Inputs="@(Proto)" Outputs="@(Proto->'$(ProjectDir)%(Filename).cs')">
<ItemGroup>
<_protoc Include="..\packages\Google.Protobuf.*\tools\protoc.exe" />
</ItemGroup>
<Error Condition="!Exists(@(_protoc))" Text="Could not find protoc.exe" />
<Exec Command=""@(_protoc)" "--csharp_out=$(ProjectDir.TrimEnd('\'))" @(Proto->'%(Identity)',' ')" WorkingDirectory="$(ProjectDir)" />
</Target>
я прикрепил быструю и грязную оболочку пользовательского инструмента Visual Studio вокруг ProtoGen.exe на кодовую страницу Google для этой проблемы (http://code.google.com/p/protobuf-net/issues/detail?id=39). Это делает добавление .proto файлы для проектов C# очень легко.
см. readme в приложении для получения дополнительной информации.