创建你的第一个WebService
这是一个关于构建并允许并同时看一看不同组件是如何工作的快速预览。
第一步:下载并安装ServiceStackVS插件
第一我们希望安装ServiceStackVS的visual studio的扩展。最简单的方式是通过内置在Visual Studio-【工具】-【扩展和更新】...进行搜索和安装
第二步:选择模板
当ServiceStackVs扩展已经安装,当你创建新的项目时你就有新的项目模板可以使用,例如,让我们选择ServiceStack ASP.NET Empty来开始。
但你通过模板来创建你的应用,你就会得到4个项目在你的解决方案中,如果你使用的是默认名字,你就会以下面的结构构建这个解决方案。
第三步:
通过F5运行你的项目
运行结果(postman):
它是如何运行的?
现在新项目已经运行,让我们来看看我们已经有了哪些内容。模板提供了一个单独的Web服务路由,该路由位于WebApplication1.ServiceModel项目下的Hello.cs文件里的请求DTO(数据传输对象)的对象。
[Route("/hello/{Name}")]
public class Hello : IReturn<HelloResponse>
{
public string Name { get; set; }
}
public class HelloResponse
{
public string Result { get; set; }
}
这个Route
特性说明路径/hello/{Name}
中{Name}
将它的值绑定到了公开的Name的字符串属性上
让我们通过这个路由来看下它的返回,通过如下人URL到你的地址栏
http://{BaseUrl}/hello/world
你可能看到一个HTML的返回格式的内容。将返回格式化为Json,只需要加?format=json
到URL的末尾,
如何你到解决方案中去找WebApplication1.ServiceInterface并且打开Myservice.cs
文件,你就可以看到响应到浏览器的代码。给我们Result
的返回
public class MyServices : Service
{
public object Any(Hello request)
{
return new HelloResponse { Result = $"Hello, {request.Name}!" };
}
}
如何你看上面代码,必须注意一些事情。方法名Any
意味着方法运行在任何可能的Http Verbs上,服务方法就是你控制从你的服务中返回内容的地方。
第四步:探索这个ServiceStack的解决方案
下面推荐的结构是构建进了所有的ServiceStack VS.NET的模板中,模板创建任何一个ServiceStack项目至少包含四个项目来保证解决方案从一开始就是最佳逻辑项目层次,并为后续项目的可维护性,高内聚,可复用打下基础。
Host Project
这个主项目包含你的AppHost,它引用和注册在IOC中的所有依赖项,并且包含了所有配置项和全局行为的中心位置。它也引用了所有的Web资源,例如razor Views,JS,CSS,Images,Fonts等。这需要同应用一起部署。AppHost是一个顶层项目,他引用了应用程序锁使用的所有依赖项,它的作用类似于一个协调器和管道,它决定了那些功能可用,那些具体实现被使用。被设计为引用所有项目同时不被其他项目引用,作为一个全局目标,应该避免任何应用和业务逻辑。
ServiceInterface Project
服务接口项目时包含了所有业务逻辑和服务的实现项目。它引用了除Host Project的所有项目,中小型项目可以通过逻辑划分特性文件夹来包含所有的实现。大型解决方案可以划分未更加内聚的模块项目,同时我们建议封装他们可能使用的所有依赖。
ServiceModel Project
ServiceModel 项目包含所有的你的程序的数据传输对象,这些对象定义了你的服务契约。keeping them isolated from any Server implementation is how your Service is able to encapsulate its capabilities and make them available behind a remote facade.对于每一个解决方案最好只有一个包含你所有DTOs的ServiceModel项目。作为实现项,依赖项,无逻辑的服务契约,从实现和相互依赖来确保你的服务不会包含特定的客户端实现,并且确保这是唯一需要客户端通过直接引用ServiceModel.dll或者通过添加ServiceStack引用远程ServiceStack服务实例下载Dtos的来调用你的服务的项目。