dotnet-grpc ile Protobuf başvurularını yönetme
Uyarı
ASP.NET Core'un bu sürümü artık desteklenmiyor. Daha fazla bilgi için bkz . .NET ve .NET Core Destek İlkesi. Geçerli sürüm için bu makalenin .NET 8 sürümüne bakın.
dotnet-grpc
, .NET gRPC projesinde Protobuf (.proto
) başvurularını yönetmeye yönelik bir .NET Core Genel Aracıdır. Araç Protobuf başvuruları eklemek, yenilemek, kaldırmak ve listelemek için kullanılabilir.
Yükleme
.NET Core Genel Aracı'nı dotnet-grpc
yüklemek için aşağıdaki komutu çalıştırın:
dotnet tool install -g dotnet-grpc
Not
Varsayılan olarak yüklenecek .NET ikili dosyalarının mimarisi şu anda çalışan işletim sistemi mimarisini temsil eder. Farklı bir işletim sistemi mimarisi belirtmek için bkz . dotnet tool install, --arch option. Daha fazla bilgi için bkz. GitHub sorunu dotnet/AspNetCore.Docs #29262.
Başvuru ekleme
dotnet-grpc
Protobuf başvurularını dosyaya öğe olarak <Protobuf />
eklemek için .csproj
kullanılabilir:
<Protobuf Include="Protos\greet.proto" GrpcServices="Server" />
Protobuf başvuruları, C# istemcisi ve/veya sunucu varlıklarını oluşturmak için kullanılır. Araç dotnet-grpc
aşağıdakileri yapabilir:
- Disk üzerindeki yerel dosyalardan bir Protobuf başvurusu oluşturun.
- URL tarafından belirtilen uzak bir dosyadan Protobuf başvurusu oluşturun.
- Projeye doğru gRPC paket bağımlılıklarının eklendiğinden emin olun.
Örneğin, Grpc.AspNetCore
paket bir web uygulamasına eklenir. Grpc.AspNetCore
gRPC sunucusu ve istemci kitaplıkları ile araç desteği içerir. Alternatif olarak, Grpc.Net.Client
Grpc.Tools
yalnızca gRPC istemci kitaplıklarını ve Google.Protobuf
araç desteğini içeren ve paketleri bir Konsol uygulamasına eklenir.
Dosya Ekle
add-file
Komutu, diske Protobuf başvuruları olarak yerel dosyalar eklemek için kullanılır. Sağlanan dosya yolları:
- Geçerli dizine veya mutlak yollara göre olabilir.
- Desen tabanlı dosya globbing için joker karakterler içerebilir.
Proje dizininin dışında herhangi bir dosya varsa, dosyayı Visual Studio'daki klasörün Protos
altında görüntülemek için bir Link
öğesi eklenir.
Kullanım
dotnet-grpc add-file [options] <files>...
Bağımsız değişkenler
Bağımsız değişken | Açıklama |
---|---|
files | Protobuf dosyası başvurur. Bunlar yerel protobuf dosyaları için glob yolu olabilir. |
Seçenekler
Kısa seçenek | Uzun seçenek | Açıklama |
---|---|---|
-p | --proje | Üzerinde çalışacak proje dosyasının yolu. Bir dosya belirtilmezse, komut geçerli dizinde bir dosya arar. |
-s | --Hizmetleri | Oluşturulması gereken gRPC hizmetlerinin türü. belirtilirse Default , Both Web projeleri için kullanılır ve Client Web dışı projeler için kullanılır. Kabul edilen değerler , Both , Client Default , None , . Server |
-i | --additional-import-dirs | Protobuf dosyaları için içeri aktarmalar çözümlendiğinde kullanılacak ek dizinler. Bu, yolların noktalı virgülle ayrılmış listesidir. |
--erişim | Oluşturulan C# sınıfları için kullanılacak erişim değiştirici. Varsayılan değer şudur: Public . Kabul edilen değerler ve Public değerleridirInternal . |
URL ekleyin
Komut add-url
, kaynak URL tarafından belirtilen uzak bir dosyayı Protobuf başvurusu olarak eklemek için kullanılır. Uzak dosyanın indirileceği yeri belirtmek için bir dosya yolu sağlanmalıdır. Dosya yolu, geçerli dizine veya mutlak bir yola göre olabilir. Dosya yolu proje dizininin dışındaysa, dosyayı Visual Studio'daki sanal klasörün Protos
altında görüntülemek için bir Link
öğe eklenir.
Kullanım
dotnet-grpc add-url [options] <url>
Bağımsız değişkenler
Bağımsız değişken | Açıklama |
---|---|
url | Uzak bir protobuf dosyasının URL'si. |
Seçenekler
Kısa seçenek | Uzun seçenek | Açıklama |
---|---|---|
-o | --output | Uzak protobuf dosyasının indirme yolunu belirtir. Bu gerekli bir seçenektir. |
-p | --proje | Üzerinde çalışacak proje dosyasının yolu. Bir dosya belirtilmezse, komut geçerli dizinde bir dosya arar. |
-s | --Hizmetleri | Oluşturulması gereken gRPC hizmetlerinin türü. belirtilirse Default , Both Web projeleri için kullanılır ve Client Web dışı projeler için kullanılır. Kabul edilen değerler , Both , Client Default , None , . Server |
-i | --additional-import-dirs | Protobuf dosyaları için içeri aktarmalar çözümlendiğinde kullanılacak ek dizinler. Bu, yolların noktalı virgülle ayrılmış listesidir. |
--erişim | Oluşturulan C# sınıfları için kullanılacak erişim değiştirici. Varsayılan değer Public olarak belirlenmiştir. Kabul edilen değerler ve Public değerleridirInternal . |
Kaldır
remove
komutu, Dosyadan .csproj
Protobuf başvurularını kaldırmak için kullanılır. komutu, yol bağımsız değişkenlerini ve kaynak URL'leri bağımsız değişken olarak kabul eder. Araç:
- Yalnızca Protobuf başvuruyu kaldırır.
- Başlangıçta uzak bir URL'den indirilmiş olsa bile dosyayı silmez
.proto
.
Kullanım
dotnet-grpc remove [options] <references>...
Bağımsız değişkenler
Bağımsız değişken | Açıklama |
---|---|
başvurular | Kaldırılacak protobuf başvurularının URL'leri veya dosya yolları. |
Seçenekler
Kısa seçenek | Uzun seçenek | Açıklama |
---|---|---|
-p | --proje | Üzerinde çalışacak proje dosyasının yolu. Bir dosya belirtilmezse, komut geçerli dizinde bir dosya arar. |
Yenile
refresh
Komutu, uzak başvuruyu kaynak URL'den en son içerikle güncelleştirmek için kullanılır. Güncelleştirilecek başvuruyu belirtmek için hem indirme dosyası yolu hem de kaynak URL kullanılabilir. Not:
- Dosya içeriğinin karmaları, yerel dosyanın güncelleştirilip güncelleştirilmeyeceğini belirlemek için karşılaştırılır.
- Hiçbir zaman damgası bilgisi karşılaştırılır.
Bir güncelleştirme gerekiyorsa araç her zaman yerel dosyayı uzak dosyayla değiştirir.
Kullanım
dotnet-grpc refresh [options] [<references>...]
Bağımsız değişkenler
Bağımsız değişken | Açıklama |
---|---|
başvurular | Güncelleştirilmesi gereken uzak protobuf başvurularının URL'leri veya dosya yolları. Tüm uzak başvuruları yenilemek için bu bağımsız değişkeni boş bırakın. |
Seçenekler
Kısa seçenek | Uzun seçenek | Açıklama |
---|---|---|
-p | --proje | Üzerinde çalışacak proje dosyasının yolu. Bir dosya belirtilmezse, komut geçerli dizinde bir dosya arar. |
--dry-run | Yeni içerik indirmeden güncelleştirilecek dosyaların listesini oluşturur. |
Liste
list
komutu, proje dosyasındaki tüm Protobuf başvurularını görüntülemek için kullanılır. Bir sütunun tüm değerleri varsayılan değerlerse, sütun atlanabilir.
Kullanım
dotnet-grpc list [options]
Seçenekler
Kısa seçenek | Uzun seçenek | Açıklama |
---|---|---|
-p | --proje | Üzerinde çalışacak proje dosyasının yolu. Bir dosya belirtilmezse, komut geçerli dizinde bir dosya arar. |
Ek kaynaklar
ASP.NET Core