Group items tagged

存取資料庫是一種相對很慢的I/O的操作：每一條SQL query都得耗上時間、執行回傳的結果也會被轉成ActiveRecord物件全部放進記憶體

如果需要撈出全部的資料做處理，強烈建議最好不要用all方法，因為這樣會把全部的資料一次放進記憶體中，如果資料有成千上萬筆的話，效能就墜毀了。

.find_each( :batch_size => 100 )

.find_in_batches( :batch_size => 100 )

在Transaction交易範圍內的SQL效能會加快，因為最後只需要COMMIT一次即可

Elasticsearch全文搜尋引擎和elasticsearch-rails gem

QueryReviewer這個套件透過SQL EXPLAIN分析SQL query的效率

必要時可以採用逆正規化的設計。犧牲空間，增加修改的麻煩，但是讓讀取這事件變得更快更簡單。

將成本轉嫁到寫入，而最佳化了讀取時間

在效能還沒有造成問題前，就為了優化效能而修改程式和架構，只會讓程式更混亂不好維護

當效能還不會造成問題時，程式的維護性比考慮效能重要

會拖慢整體效能的程式，只佔全部程式的一小部分而已，所以我們只最佳化會造成問題的程式。

善用分析工具找效能瓶頸，最佳化前需要測量，最佳化後也要測量比較。

rack-mini-profiler在頁面的左上角顯示花了多少時間，並且提供報表，推薦安裝

如果是不需要權限控管的靜態檔案，可以直接放在public目錄下讓使用者下載。

Web伺服器得先安裝好x_sendfile功能

如果要讓你的Assets例如CSS, JavaScript, Images也讓使用者透過CDN下載，只要修改config/environments/production.rb的config.action_controller.asset_host為CDN網址即可。

有時候「執行速度較快」的程式碼不代表好維護、好除錯的程式碼

Ruby不是萬能，有時候直接呼叫外部程式是最快的作法

mount multiple API implementations inside another one

mount on a path, which is similar to using prefix inside the mounted API itself.

four strategies in which clients can reach your API's endpoints: :path, :header, :accept_version_header and :param

clients should pass the desired version as a request parameter, either in the URL query string or in the request body.

clients should pass the desired version in the HTTP Accept head

clients should pass the desired version in the UR

clients should pass the desired version in the HTTP Accept-Version header.

add a description to API methods and namespaces

Parameters are automatically populated from the request body on POST and PUT

route string parameters will have precedence.

Grape allows you to access only the parameters that have been declared by your params block

By default declared(params) includes parameters that have nil values

type: File

JSON objects and arrays of objects are accepted equally

any class can be used as a type so long as an explicit coercion method is supplied

As a special case, variant-member-type collections may also be declared, by passing a Set or Array with more than one member to type

Parameters can be nested using group or by calling requires or optional with a block

relevant if another parameter is given

Parameters options can be grouped

allow_blank can be combined with both requires and optional

Parameters can be restricted to a specific set of values

Parameters can be restricted to match a specific regular expression

Never define mutually exclusive sets with any required params

Namespaces allow parameter definitions and apply to every method within the namespace

define a route parameter as a namespace using route_param

create custom validation that use request to validate the attribute

rescue a Grape::Exceptions::ValidationErrors and respond with a custom response or turn the response into well-formatted JSON for a JSON API that separates individual parameters and the corresponding error messages

custom validation messages

Request headers are available through the headers helper or from env in their original form

define requirements for your named route parameters using regular expressions on namespace or endpoint

mix in a module

define reusable params

using cookies method

a 201 for POST-Requests

204 for DELETE-Requests

200 status code for all other Requests

use status to query and set the actual HTTP Status Code

raising errors with error!

rescue_from will rescue the exceptions listed and all their subclasses.

Grape::API provides a logger method which by default will return an instance of the Logger class from Ruby's standard library.

Grape supports a range of ways to present your data

Grape has built-in Basic and Digest authentication (the given block is executed in the context of the current Endpoint).

Blocks can be executed before or after every API call, using before, after, before_validation and after_validation

Grape by default anchors all request paths, which means that the request URL should match from start to end to match

test a Grape API with RSpec by making HTTP requests and examining the response

POST JSON data and specify the correct content-type.

程序中使用了 jQuery 代码库和许多模块，都保存在 lib/assets/javascripts/library_name 文件夹中，那么 lib/assets/javascripts/library_name/index.js 文件的作用就是这个代码库的清单。清单文件中可以按顺序列出所需的文件，或者干脆使用 require_tree 指令。

如果使用 Turbolinks（Rails 4 默认启用），加上 data-turbolinks-track 选项后，Turbolinks 会检查静态资源是否有更新，如果更新了就会将其载入页面

config.assets.paths 包含标准路径和其他 Rails 引擎添加的路径。

链接不存在的资源（也包括链接到空字符串的情况）会在调用页面抛出异常。

关闭标签不能使用 -%> 形式

Sprockets 通过清单文件决定要引入和伺服哪些静态资源

在 JavaScript 文件中，Sprockets 的指令以 //= 开头。在上面的文件中，用到了 require 和 the require_tree 指令。

app/assets/javascripts/application.js

require_tree 指令告知 Sprockets 递归引入指定文件夹中的所有 JavaScript 文件。文件夹的路径必须相对于清单文件。也可使用 require_directory 指令加载指定文件夹中的所有 JavaScript 文件，但不会递归。

app/assets/stylesheets/application.css

不管创建新程序时有没有指定 --skip-sprockets 选项，Rails 4 都会生成 app/assets/javascripts/application.js 和 app/assets/stylesheets/application.css

如果多次调用 require_self，只有最后一次调用有效

如果想使用多个 Sass 文件，应该使用 Sass 中的 @import 规则，不要使用 Sprockets 指令。

如果使用默认的 gem，生成控制器或脚手架时，会生成 CoffeeScript 和 SCSS 文件，而不是普通的 JavaScript 和 CSS 文件。

在开发环境中，或者禁用 Asset Pipeline 时，这些文件会使用 coffee-script 和 sass 提供的预处理器处理，然后再发给浏览器

启用 Asset Pipeline 时，这些文件会先使用预处理器处理，然后保存到 public/assets 文件夹中，再由 Rails 程序或网页服务器伺服

添加额外的扩展名可以增加预处理次数，预处理程序会按照扩展名从右至左的顺序处理文件内容。所以，扩展名的顺序要和处理的顺序一致

预处理器的执行顺序很重要

在开发环境中也可启用压缩功能，检查是否能正常运行。需要调试时再禁用压缩即可。

默认情况下，Rails 认为静态资源已经事先编译好了，直接由网页服务器伺服。

般情况下，请勿修改 config.assets.digest 的默认值

可在部署时编译静态资源

在多次部署之间共用这个文件夹是十分重要的，这样只要缓存的页面可用，其中引用的编译后的静态资源就能正常使用。

默认编译的文件包括 application.js、application.css 以及 gem 中 app/assets 文件夹中的所有非 JS/CSS 文件（会自动加载所有图片）

如果想编译其他清单，或者单独的样式表和 JavaScript，可以添加到 config/application.rb 文件中的 precompile 选项

设置编译所有静态资源

manifest-md5hash.json 的文件，列出所有静态资源和对应的指纹

把 Expires 报头设置为很久以后

在本地预编译后，可以把编译好的文件纳入版本控制系统，再按照常规的方式部署

实时编译消耗的内存更多，比默认的编译方式性能更低，因此不推荐使用

如果用 CDN 分发静态资源，要确保文件不会被缓存，因为缓存会导致问题。如果设置了 config.action_controller.perform_caching = true，Rack::Cache 会使用 Rails.cache 存储静态文件，很快缓存空间就会用完。

Sprockets 默认使用的公开路径是 /assets

X-Sendfile 报头的作用是让服务器忽略程序的响应，直接从硬盘上伺服指定的文件

为 Rails 提供标准 JavaScript 代码库的 jquery-rails gem 是个很好的例子。这个 gem 中有个引擎类，继承自 Rails::Engine。添加这层继承关系后，Rails 就知道这个 gem 中可能包含静态资源文件，会把这个引擎中的 app/assets、lib/assets 和 vendor/assets 三个文件夹加入 Sprockets 的搜索路径中。