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

我已经使用了一段时间的Visual Studio代码的Azure函数,它们继续以很好的方式发展。最近的一次换班让我陷入了一个循环,所以我想我会为那些还没有开始的人记录一些。我还应该指出,在过去一年左右的时间里,我一直专注于用JavaScript编写函数,因为我喜欢把事情搞混一点,这也使得与不以.NET为中心的开发人员共享Azure函数更加容易。

我也写过关于在msdn杂志上用vs代码创建Azure函数的文章,但同样,自从我写这篇文章以来,情况就变了。我已经使用版本2的api有一段时间了,所以我不打算讨论(好吧,在这里写)关于从v1到v2的变化,但是使用Azure函数扩展的体验的变化。

另外值得注意的是,Azure功能团队实际上建议使用Visual Studio为JavaScript构建基于C的应用程序和VS代码。但是我经常在我的MacBook上使用vs代码,所以我还是要和c一起走这条路。

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

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

正在准备Visual Studio代码

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

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

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

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

工作流的此部分未更改。

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

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

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

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

         
          
           
            网络核心应用程序2.1
           
           
            
             V2
            
          
          
           
            
          
          
           
            
             PreserveNewest
            
           
           
            
             PreserveNewest
            
            
             从来没有
            
           
          
         

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

像往常一样,以"add a function"开头图标2019-01-17 U 18-11-39副本.png

第一步很熟悉,选择功能应位于哪个文件夹中的功能应用程序:

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

我会选择azurefunctionproj。

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

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

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

过滤器选项已验证,核心和全部。核心和所有当前显示相同的列表,其中包括一些额外的预览触发器:DurableFunctionsOrchestration,发送网格,事件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脚本时使用所有这些using语句。2019年1月19日\u 15-16-45.png

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

但它不仅仅是熟悉的绑定。注意生成者,配置源,脚本文件和入口点标记。

所以第一次装订,httpTrigger绑定,我看起来很熟悉。该函数将响应httpTrigger。

您可以通过运行或调试来测试这个默认值。运行,您可以使用vs code的ctrl-f5键盘组合键,或者,如果您喜欢使用CLI,使用azure函数cli命令:

func主机启动

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

http://localhost:7071/api/httptriggercsharp?姓名=朱莉

以及浏览器输出

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

将输出绑定添加到
Azure宇宙DB

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

为了使用与Azure Cosmos DB绑定的工作,我需要将相关包添加到我的项目中。因为我正在使用C类库构建我的函数,我可以像对任何其他nuget包那样这样做…直接将其添加到csproj或使用dotnet core cli添加包:

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

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

注意,如果我使用javascript或c脚本构建函数,我需要使用工具cli(func extensions install-p)注册包packagename

现在这个包在csproj中:

          
           
            
           
          
恢复后,我可以添加输出绑定。当前默认函数是异步的,不能向异步方法添加参数。返回值是一个选项。见 https://docs.microsoft.com/en-us/azure/azure函数/函数使用函数返回值触发绑定获取详细信息。ICollector或IAsyncCollector是另一个( https://docs.microsoft.com/en-us/azure/azure-functions/functions-dotnet-class-library#writing-multiple-output-values
但我要只是使run方法同步,并创建一个输出参数。像触发器绑定参数一样,我需要向输出参数添加一个属性来指定绑定。我还提供数据库和集合名称的参数,具有到数据库帐户的连接字符串的设置的名称,以及最后一个确保在需要时创建数据库和集合的设置。
[函数名(“httpTriggerCSharp”)]public static actionResult run([httpTrigger(authorizationLevel.anonymous,“得到”,“发布”,route=null)]httprequest req,[COSMOSSDB(数据库名称:“CSharpDatabase”,collectionname:“CSharpcollection”,connectionStringsetting=“mycosmosdbconnection”,CreateIfNotExists=true)] out dynamic document,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,“得到”,“发布”,route=null)]httprequest req,[COSMOSSDB(数据库名称:“CSharpDatabase”,collectionname:“CSharpcollection”,connectionStringsetting=“mycosmosdbconnection”,CreateIfNotExists=true)] out dynamic document,ilogger log)log.loginformation(“C HTTP触发器函数处理了一个请求”);字符串名称=请求查询[“名称”];document=新建name=名称,添加=datetime.now;返回名称!=空?(actionresult)新的OkObjectResult($你好,name”):new badRequestObjectResult(“请在查询字符串上传递名称”);}}}
根据我以前手动配置function.json的经验,我希望在建造之后,bin文件夹中包含cosmossdb输出绑定信息的function.json,但没有。再一次,这是由于javascript/c脚本函数和c库函数之间的差异造成的。
在vs代码中,我可以运行或调试函数。调试是F5或调试图标。运行,没有调试,您可以使用ctrl-f5或tools cli命令:
func主机启动
使用cli命令时,我在测试中发现我使用的版本似乎需要我运行 Dotnet清除首先是成功。ctrl-f5为您完成这一步。我在现有的Github发行版中注意到了这一点。你可以读到 在这里.
官方文件中有很多有用的信息。我靠的两个是:

注册我的通讯所以你不要错过我的会议和多元化课程公告!

2“思考”在Visual Studio代码中构建基于项目的Azure函数

  1. 感谢这篇非常有用的文章,朱莉!我将要重新开始开发v1功能应用程序,这是我一年前在VS2017开始的。你知道在vs代码中是否有可能获得这种项目吗?还是我需要在.NET核心领域?再次感谢!

    1. VS代码不能支持简单的.NET框架项目。如果将项目升级为使用v2(基于.NET核心),则当然,你也可以在VS代码中使用它(在windows、Mac或linux上)。抱歉,回复延迟了。这件事没有通过我的电子邮件。

答复圣格里菲斯取消答复

您的电子邮件地址将不会发布。已标记必需字段*

此网站使用Akismet来减少垃圾邮件。了解如何处理评论数据.