标签档案:c#

在Visual Studio代码中构建基于项目的Azure函数

我在Visual Studio代码中使用Azure函数已经有一段时间了,它们还在以非常好的方式发展。最近的轮班让我陷入了一个循环,所以我想我应该为那些可能还没有开始的人编写一些文档。我还应该声明,在过去一年左右的时间里,我一直专注于用JavaScript编写函数,因为我喜欢将一些东西混在一起,而且这也使得与不专注于. net的开发人员共享Azure函数变得更加容易。

我也写过关于在msdn杂志上用vs代码创建Azure函数的文章,但同样,自从我写了这篇文章以来,情况已经发生了变化。我已经使用了一段时间的版本2 API,所以我没有说话(好吧,写)关于从v1到v2的变化,以及使用Azure函数扩展的体验的变化。

同样值得注意的是,Azure功能团队实际上推荐使用Visual Studio来构建基于c#的应用程序和用于JavaScript的VS代码。但是我经常在我的MacBook上,并且喜欢使用VS代码,所以我无论如何都要用c#沿着这条路走下去。

在对文档进行了足够多次的重新访问后,最终发现了一些关键信息,我意识到为什么使用c#的扩展会改变这种体验。在此之前,我曾经使用过C脚本函数(.csx),这与您直接在门户中工作时使用的相同。但是扩展模板现在驱动您使用c#项目函数,这是一个很大的区别。c#脚本函数更像javascript函数。它们依赖于手动创建的function.json文件来定义绑定,并可以基于绑定安装适当的扩展包。CSX文件在运行时编译。有了C类库,您可以像开发其他c#类库一样开发——安装相关的包,然后使用属性来标识方法,如Azure函数和触发器,输入和输出绑定。编译库时,Azure函数工具将为您生成一个被部署的function.json文件。

因为我习惯用JavaScript或c#脚本路径创建函数,使用C类库的Azure函数扩展的新默认值确实让我陷入了一个循环。因此,我决定用文档记录在这个工作流程中行走,因为我必须学习它。我想我还是更喜欢重量较轻的C脚本(.csx)或JavaScript流,但这可能与我在许多情况下对vs代码的偏好相一致,而不是Visual Studio。

编写Visual Studio代码

所以首先要做的是:您需要安装Azure的功能Azure帐户扩展到VS代码,Azure函数扩展依赖于Azure函数核心工具。扩展安装说明将帮助您获得所需的所有内容,扩展会检查更新并提示您根据需要更新这些工具。事实上,我昨晚收到这个提示。2019 - 01 - 16 - _09 - 28 - 10. png

安装了扩展之后,现在是创建一个函数应用程序项目的时候了。您应该已经创建了一个文件夹来存放您的项目,您也可以用VS代码打开它。我的名字叫AzureFunctionProj。

然后你可以点击“创建新项目”在功能栏上的图标(当您将鼠标悬停在功能栏上时,图标会出现),用于在文件夹中创建一个新的功能应用程序项目。

2019 - 01 - 17 - _18 - 11 - 39. png

工作流的这一部分没有更改。

  1. 它会要求你指向一个文件夹,打开的文件夹应该在那里作为默认选择。
  2. 然后它会让你选择一种你将在应用程序中使用的语言。从选项(c,JavaScriptPython(仍然是预览)和Java(也是预览),我将选择c#。

因此,一个新的。net核心项目将使用模板创建,您将在文件夹资源管理器中看到以下内容:

2019-01-17_18-19-58.png

azurefunctionproj文件夹中的所有这些文件都是由模板创建的。最重要的是csproj文件,我在其中突出显示了一些最相关的设置。

         
          
           
            NETCOREAPP2.1
           
           
            
             v2
            
          
          
           
            
          
          
           
            
             PreserveNewest
            
           
           
            
             PreserveNewest
            
            
             从未
            
           
          
         

在函数应用程序中创建一个函数,事情就大不一样了。

像往常一样,以"add a function"开头偶像2019 - 01 - 17 - _18 - 11 - 39 copy.png

第一步很熟悉,选择哪个文件夹有函数应用程序,函数应该在:

2019-01-17_22-06-37.png

我将选择AzureFunctionProj。

然后有许多触发器模板可供选择,下面的三个选项更有趣:

2019 - 01 - 17 - _16 - 42 - 25. png首先是项目运行时,我肯定想要v2(“~2”)。你可以在函数应用中为不同的函数使用不同的语言。这显示了我已经选择的默认值:c#。最后,触发器模板列表过滤为“已验证”。

您可以通过单击这些选项来更改它们。

过滤器选项被验证,核心和所有。核心和所有当前显示相同的列表,其中包括一些额外的预览触发器:DurableFunctionsOrchestration,SendGrid,事件hubtrigger和iothubtrigger。

2019-01-17_16-43-20.png

过去我在。net核心函数应用程序中创建JavaScript函数,但现在我将继续使用c#,因为这是真正让我吃惊的地方。我将选择httptrigger,然后系统会提示我提供一个名称。我将保留默认值:HttpTriggerCSharp。然后要求我为将要创建的类提供一个名称空间名称。默认为“company.project”。我将把它改为functiontests.httptest1。要收集的最后一点信息是,您需要为函数选择安全性。选项中,我将选择匿名,因为这是一个演示,我不想处理凭证。

就是这样。将创建函数。

还有一些类库项目的差异

我过去的经验告诉我,在app function文件夹中创建一个新文件夹,里面有函数名,将是函数的类文件和包含绑定配置的function.json文件。类文件在那里(虽然不在它自己的文件夹中)。但是没有function.json文件。对我来说,运行方法上的FunctionName属性和运行方法签名中的HttpRequest上的HttpTrigger属性也是有趣的和新的。也,我不习惯在使用csx脚本时使用所有这些语句。2019 - 01 - 19 - _15 - 16 - 45. png

在建设项目时,.NET核心读取该属性并构建一个进入bin文件夹进行部署的function.json。2019-01-17_22-38-03.png

但这不仅仅是熟悉的绑定。注意到generatedBy,配置源,scriptFile和entryPoint标记。

第一个绑定,httpTrigger绑定,我看起来很熟悉。函数将响应httptrigger。

您可以通过运行或调试来测试这个默认值。奔跑,你可以使用VS Code的CTRL-F5键盘组合,如果您喜欢使用CLI,使用azure函数cli命令:

func主机开始

这将运行该函数并提供一个url进行尝试。模板“赌注”方法的编写目的是接受主体中的查询参数或JSON。我将使用一个查询参数:

http://localhost:7071/api/HttpTriggerCSharp?name=Julie

以及浏览器输出

2019 - 01 - 19 - _15 - 57 - 04. png

将输出绑定添加到
天青宇宙DB

如果我想添加一个输出绑定呢?我习惯通过编辑function.json来实现这一点。但是由于我在属性定义绑定的路径上,我会这样添加绑定。让我们为Azure Cosmos DB添加一个输出绑定。这样,该函数将响应HTTP请求并将一些数据插入Cosmos DB数据库。我已经有一个Azure Cosmos DB账号了,因此,我将定义它来针对现有帐户中的新数据库中的新集合。

为了使用Azure Cosmos DB绑定,我需要将相关包添加到我的项目中。因为我使用c#类库来构建函数,我可以这样做,就像我对任何其他Nuget包…直接添加到csproj或添加包与dotnet核心CLI:

但是现在我正在编写一个c#类库,这样我就可以使用dotnet CLI添加包,或者手动将它添加到.csproj中。我会使用CLI:

dotnet添加包microsoft.azure.webjobs.extensions.cosmossdb--版本3.0.3

注意,如果我使用javascript或c脚本构建函数,我需要使用CLI (func extensions install -p)工具注册这个包包装名)。

现在包在csproj:

          
           
            
           
          
恢复后,我可以添加输出绑定。当前默认函数是异步的,不能向异步方法添加参数。返回值是一种选择。见 https://docs.microsoft.com/en-us/azure/azure-functions/functions-triggers-bindings#using-the-function-return-value详情。ICollector或IAsyncCollector是另一个( https://docs.microsoft.com/en-us/azure/azure-functions/functions-dotnet类库写入多个输出值)。
但是我将使Run方法同步并创建一个输出参数。就像触发器绑定参数一样,我需要向输出参数添加一个属性来指定绑定。我还为数据库和集合名提供参数,具有到数据库帐户的连接字符串的设置的名称,以及最后一个确保在需要时创建数据库和集合的设置。
[FunctionName("HttpTriggerCSharp")]公共静态ActionResult Run([HttpTrigger(AuthorizationLevel.Anonymous,“得到”,“文章”,HttpRequest req,[CosmosDB(数据库名:“CSharpDatabase”,collectionName:“CSharpCollection”,connectionStringsetting=“mycosmosdbconnection”,createifnotexists=true)]out动态文档,ILogger实例日志)
我添加了mycosmosdbconnection,它是在local.settings.json文件中定义的:
{“IsEncrypted”:假的,“values”:“azurewebjobsstorage”:“”,:“FUNCTIONS_WORKER_RUNTIME dotnet”,“MyCosmosDBConnection”:“这是我的连接字符串的位置“}
注意,如果您使用Azure Cosmos DB触发器创建一个新函数,工具会提示您输入所有相关的数据库信息,在函数代码中包含一个属性,并将其添加到function.json中。
现在只有最后一块拼图了。该函数希望我为文档变量提供一个值,然后绑定将该值插入数据库。下面是完整的类清单,其中用红色突出显示了用名称和添加属性填充文档的一行。函数和绑定将完成剩下的所有工作。
使用系统;使用Microsoft.AspNetCore.Mvc;使用Microsoft.Azure.WebJobs;使用Microsoft.Azure.WebJobs.Extensions.Http;使用Microsoft.AspNetCore.Http;使用Microsoft.Extensions.Logging;命名空间函数tests.httptest1公共静态类httptriggercsharp[函数名(“httptriggercsharp”)]公共静态操作结果运行([httptrigger(authorizationlevel.anonymous,“得到”,“文章”,HttpRequest req,[CosmosDB(数据库名:“CSharpDatabase”,collectionName:“CSharpCollection”,connectionStringsetting=“mycosmosdbconnection”,createifnotexists=true)]out动态文档,ilogger log)log.loginformation(“C HTTP触发器函数处理了一个请求”);string name = req.Query["name"];document=新建name=名称,添加=datetime.now;返回名称!= NULL?(actionresult)新的OkObjectResult($你好,name”):new badRequestObjectResult(“请在查询字符串上传递名称”);}}}
根据我之前手工配置function.json的经验,我以为建好房子后,bin文件夹中包含cosmossdb输出绑定信息的function.json,但没有。再一次,这是由于JavaScript/ c#脚本函数和c#库函数之间的差异造成的。
在VS代码中,我可以运行或调试函数。调试是F5或调试图标。奔跑,如果没有调试,您可以使用CTRL-F5或工具CLI命令:
func主机开始
当使用CLI命令时,我在测试中发现我使用的版本似乎需要我运行 清洁网首先要让它成功。ctrl-f5为您完成这一步。我在一个预先存在的GitHub问题中记录了这一点。你们可以读到 在这里
在官方文档中有很多有用的信息。我所倚重的两件事是: